Puppet Class: octavia::certificates

Defined in:
manifests/certificates.pp

Overview

Class: octavia::certificates

Configure the octavia certificates for TLS authentication

Parameters

cert_generator

(Optional) Certificate generator to use. Defaults to $::os_service_default

cert_manager

(Optional) Certificate manager to use. Defaults to $::os_service_default

barbican_auth

(Optional) Name of the Barbican authentication method to use. Defaults to $::os_service_default

service_name

(Optional) The name of the certificate service in the keystone catalog. Defaults to $::os_service_default

endpoint

(Optional) A new endpoint to override the endpoint in the keystone catalog. Defaults to $::os_service_default

region_name

(Optional) Region name to use when connecting to cert manager. Defaults to $::os_service_default

endpoint_type

(Optional) Endpoint type to use when connecting to cert manager. Defaults to $::os_service_default

ca_certificate

(Optional) Path to the CA certificate for Octavia Defaults to $::os_service_default

ca_private_key

(Optional) Path for private key used to sign certificates Defaults to $::os_service_default

server_certs_key_passphrase

(Optional) Passphrase for encrypting Amphora Certificates and Private Keys. Must be exactly 32 characters. Defaults to ‘insecure-key-do-not-use-this-key’

ca_private_key_passphrase

(Optional) CA password used to sign certificates Defaults to $::os_service_default

client_ca

(Optional) Path to the client CA certificate. This option is not needed unless you want to separate the ca_certificate/server_ca and the client_ca. Defaults to undef

client_cert

(Optional) Path for client certificate used to connect to amphorae. Defaults to $::os_service_default

ca_certificate_data

(Optional) CA certificate for Octavia Defaults to undef

ca_private_key_data

(Optional) CA private key for signing certificates Defaults to undef

client_ca_data

(Optional) Client CA certificate. You must specify the client_ca parameter where to place this CA if you give the data here. Defaults to undef

client_cert_data

(Optional) Client certificate used for connecting to amphorae Defaults to undef

file_permission_owner

(Optional) User account for file owner. Defaults to ‘octavia’

file_permission_group

(Optional) User group for file permissions Defaults to ‘octavia’

Parameters:

  • cert_generator (Any) (defaults to: $::os_service_default)
  • cert_manager (Any) (defaults to: $::os_service_default)
  • barbican_auth (Any) (defaults to: $::os_service_default)
  • service_name (Any) (defaults to: $::os_service_default)
  • endpoint (Any) (defaults to: $::os_service_default)
  • region_name (Any) (defaults to: $::os_service_default)
  • endpoint_type (Any) (defaults to: $::os_service_default)
  • ca_certificate (Any) (defaults to: $::os_service_default)
  • ca_private_key (Any) (defaults to: $::os_service_default)
  • server_certs_key_passphrase (Any) (defaults to: 'insecure-key-do-not-use-this-key')
  • ca_private_key_passphrase (Any) (defaults to: $::os_service_default)
  • client_ca (Any) (defaults to: undef)
  • client_cert (Any) (defaults to: $::os_service_default)
  • ca_certificate_data (Any) (defaults to: undef)
  • ca_private_key_data (Any) (defaults to: undef)
  • client_ca_data (Any) (defaults to: undef)
  • client_cert_data (Any) (defaults to: undef)
  • file_permission_owner (Any) (defaults to: 'octavia')
  • file_permission_group (Any) (defaults to: 'octavia') 


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
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
217
218
219
220
221
222
223
224
225
226
 
# File 'manifests/certificates.pp', line 88

class octavia::certificates (
  $cert_generator              = $::os_service_default,
  $cert_manager                = $::os_service_default,
  $barbican_auth               = $::os_service_default,
  $service_name                = $::os_service_default,
  $endpoint                    = $::os_service_default,
  $region_name                 = $::os_service_default,
  $endpoint_type               = $::os_service_default,
  $ca_certificate              = $::os_service_default,
  $ca_private_key              = $::os_service_default,
  $server_certs_key_passphrase = 'insecure-key-do-not-use-this-key',
  $ca_private_key_passphrase   = $::os_service_default,
  $client_ca                   = undef,
  $client_cert                 = $::os_service_default,
  $ca_certificate_data         = undef,
  $ca_private_key_data         = undef,
  $client_ca_data              = undef,
  $client_cert_data            = undef,
  $file_permission_owner       = 'octavia',
  $file_permission_group       = 'octavia'
) {

  include octavia::deps

  $client_ca_real = pick($client_ca, $ca_certificate)

  octavia_config {
    'certificates/cert_generator'              : value => $cert_generator;
    'certificates/cert_manager'                : value => $cert_manager;
    'certificates/barbican_auth'               : value => $barbican_auth;
    'certificates/service_name'                : value => $service_name;
    'certificates/endpoint'                    : value => $endpoint;
    'certificates/region_name'                 : value => $region_name;
    'certificates/endpoint_type'               : value => $endpoint_type;
    'certificates/ca_certificate'              : value => $ca_certificate;
    'certificates/ca_private_key'              : value => $ca_private_key;
    'certificates/server_certs_key_passphrase' : value => $server_certs_key_passphrase;
    'certificates/ca_private_key_passphrase'   : value => $ca_private_key_passphrase;
    'controller_worker/client_ca'              : value => $client_ca_real;
    'haproxy_amphora/client_cert'              : value => $client_cert;
    'haproxy_amphora/server_ca'                : value => $ca_certificate;
  }

  if !$server_certs_key_passphrase  {
    fail('server_certs_key_passphrase is required for Octavia. Please provide a 32 characters passphrase.')
  }

  if length($server_certs_key_passphrase)!=32 {
    fail('server_certs_key_passphrase must be 32 characters long.')
  }

  # The file creation will create the parent directory for each file if necessary, but
  # only to one level.
  if $ca_certificate_data {
    if is_service_default($ca_certificate) {
      fail('You must provide a path for storing the CA certificate')
    }
    ensure_resource('file', dirname($ca_certificate), {
      ensure => directory,
      owner  => $file_permission_owner,
      group  => $file_permission_group,
      mode   => '0755',
      tag    => 'octavia-certificate',
    })
    file { $ca_certificate:
      ensure    => file,
      content   => $ca_certificate_data,
      group     => $file_permission_owner,
      owner     => $file_permission_group,
      mode      => '0755',
      replace   => true,
      show_diff => false,
      tag       => 'octavia-certificate',
    }
  }
  if $ca_private_key_data {
    if is_service_default($ca_private_key) {
      fail('You must provide a path for storing the CA private key')
    }
    ensure_resource('file', dirname($ca_private_key), {
      ensure => directory,
      owner  => $file_permission_owner,
      group  => $file_permission_group,
      mode   => '0755',
      tag    => 'octavia-certificate',
    })
    file { $ca_private_key:
      ensure    => file,
      content   => $ca_private_key_data,
      group     => $file_permission_owner,
      owner     => $file_permission_group,
      mode      => '0755',
      replace   => true,
      show_diff => false,
      tag       => 'octavia-certificate',
    }
  }
  if $client_ca and $client_ca_data {
    ensure_resource('file', dirname($client_ca), {
      ensure => directory,
      owner  => $file_permission_owner,
      group  => $file_permission_group,
      mode   => '0755',
      tag    => 'octavia-certificate',
    })
    file { $client_ca:
      ensure    => file,
      content   => $client_ca_data,
      group     => $file_permission_owner,
      owner     => $file_permission_group,
      mode      => '0755',
      replace   => true,
      show_diff => false,
      tag       => 'octavia-certificate',
    }
  }
  if $client_cert_data {
    if is_service_default($client_cert) {
      fail('You must provide a path for storing the client certificate')
    }
    ensure_resource('file', dirname($client_cert), {
      ensure => directory,
      owner  => $file_permission_owner,
      group  => $file_permission_group,
      mode   => '0755',
      tag    => 'octavia-certificate',
    })
    file { $client_cert:
      ensure    => file,
      content   => $client_cert_data,
      group     => $file_permission_owner,
      owner     => $file_permission_group,
      mode      => '0755',
      replace   => true,
      show_diff => false,
      tag       => 'octavia-certificate',
    }
  }
}