Puppet Class: k8s::server::etcd

Defined in:
manifests/server/etcd.pp

Summary

Sets up an etcd cluster node

Overview

Parameters:

  • addn_names (K8s::TLS_altnames) (defaults to: [])

    additional names for certificates

  • cert_path (Stdlib::Unixpath) (defaults to: '/var/lib/etcd/certs')

    path to cert files

  • client_ca_cert (Stdlib::Unixpath) (defaults to: "${cert_path}/client-ca.pem")
  • client_ca_key (Stdlib::Unixpath) (defaults to: "${cert_path}/client-ca.key")
  • cluster_name (String[1]) (defaults to: pick($k8s::server::etcd_cluster_name, 'default'))

    name of the etcd cluster for searching its nodes in the puppetdb

  • ensure (K8s::Ensure) (defaults to: 'present')

    set ensure for installation or deinstallation

  • firewall_type (Optional[K8s::Firewall]) (defaults to: $k8s::server::firewall_type)

    define the type of firewall to use

  • generate_ca (Boolean) (defaults to: false)

    whether to generate a own ca or not

  • manage_certs (Boolean) (defaults to: true)

    whether to manage certs or not

  • manage_firewall (Boolean) (defaults to: false)

    whether to manage firewall or not

  • manage_members (Boolean) (defaults to: false)

    whether to manage the ectd cluster member joining or not

  • manage_setup (Boolean) (defaults to: true)

    whether to manage the setup of etcd or not

  • peer_ca_cert (Stdlib::Unixpath) (defaults to: "${cert_path}/peer-ca.pem")
  • peer_ca_key (Stdlib::Unixpath) (defaults to: "${cert_path}/peer-ca.key")
  • puppetdb_discovery_tag (String[1]) (defaults to: pick($k8s::server::puppetdb_discovery_tag, $cluster_name))

    enable puppetdb resource searching

  • self_signed_tls (Boolean) (defaults to: false)
  • version (String[1]) (defaults to: pick($k8s::etcd_version, '3.5.1'))

    version of ectd to install

  • user (String[1]) (defaults to: 'etcd')
  • group (String[1]) (defaults to: 'etcd')


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
# File 'manifests/server/etcd.pp', line 21

class k8s::server::etcd (
  K8s::Ensure $ensure = 'present',
  String[1] $version  = pick($k8s::etcd_version, '3.5.1'),

  Boolean $manage_setup             = true,
  Boolean $manage_firewall          = false,
  Boolean $manage_members           = false,
  String[1] $cluster_name           = pick($k8s::server::etcd_cluster_name, 'default'),
  String[1] $puppetdb_discovery_tag = pick($k8s::server::puppetdb_discovery_tag, $cluster_name),

  Boolean $self_signed_tls = false,
  Boolean $manage_certs    = true,
  Boolean $generate_ca     = false,

  K8s::TLS_altnames $addn_names = [],

  Stdlib::Unixpath $cert_path      = '/var/lib/etcd/certs',
  Stdlib::Unixpath $peer_ca_key    = "${cert_path}/peer-ca.key",
  Stdlib::Unixpath $peer_ca_cert   = "${cert_path}/peer-ca.pem",
  Stdlib::Unixpath $client_ca_key  = "${cert_path}/client-ca.key",
  Stdlib::Unixpath $client_ca_cert = "${cert_path}/client-ca.pem",

  Optional[K8s::Firewall] $firewall_type = $k8s::server::firewall_type,
  String[1] $user  = 'etcd',
  String[1] $group = 'etcd',
) {
  if (!$self_signed_tls and $manage_certs) or $ensure == 'absent' {
    if !defined(File[$cert_path]) {
      file { $cert_path:
        ensure => stdlib::ensure($ensure, 'directory'),
        owner  => $user,
        group  => $group,
      }
    }

    $_addn_names = delete_undef_values( # prevent undef value if ipv6 is turned off
      [
        fact('networking.hostname'),
        fact('networking.fqdn'),
        fact('networking.ip'),
        fact('networking.ip6'),
        'localhost',
        '127.0.0.1',
        '::1',
      ] + $addn_names
    ).unique

    k8s::server::tls::ca {
      default:
        ensure   => $ensure,
        owner    => $user,
        group    => $group,
        generate => $generate_ca;

      'etcd-peer-ca':
        key  => $peer_ca_key,
        cert => $peer_ca_cert;

      'etcd-client-ca':
        key  => $client_ca_key,
        cert => $client_ca_cert;
    }

    k8s::server::tls::cert {
      default:
        ensure    => $ensure,
        owner     => $user,
        group     => $group,
        cert_path => $cert_path;

      'etcd-server':
        ca_key             => $client_ca_key,
        ca_cert            => $client_ca_cert,
        addn_names         => $_addn_names,
        distinguished_name => {
          commonName => fact('networking.fqdn'),
        },
        extended_key_usage => ['serverAuth'];

      'etcd-peer':
        ca_key             => $peer_ca_key,
        ca_cert            => $peer_ca_cert,
        addn_names         => $_addn_names,
        distinguished_name => {
          commonName => fact('networking.fqdn'),
        },
        extended_key_usage => ['serverAuth', 'clientAuth'];

      'etcd-client':
        ca_key             => $client_ca_key,
        ca_cert            => $client_ca_cert,
        distinguished_name => {
          commonName => 'etcd client',
        };
    }
  }

  if $manage_setup and !$manage_members {
    include k8s::server::etcd::setup
  }

  if $ensure == 'present' and $manage_members {
    # Needs the PuppetDB terminus installed
    $pql_query = [
      'resources[certname,parameters] {',
      '  type = \'Class\' and',
      '  title = \'K8s::Server::Etcd::Setup\' and',
      '  nodes {',
      '    resources {',
      '      type = \'Class\' and',
      '      title = \'K8s::Server::Etcd\' and',
      "      parameters.cluster_name = '${cluster_name}' and",
      "      parameters.puppetdb_discovery_tag = '${puppetdb_discovery_tag}' and",
      "      certname != '${trusted[certname]}'",
      '    }',
      '  }',
      '  order by certname }',
    ].join(' ')

    $cluster_nodes = puppetdb_query($pql_query)
    if $manage_setup {
      class { 'k8s::server::etcd::setup':
        initial_cluster       => $cluster_nodes.map |$node| {
          "${node['parameters']['etcd_name']}=${node['parameters']['initial_advertise_peer_urls'][0]}"
        },
        initial_cluster_state => ($cluster_nodes.size() ? {
            0       => 'new',
            default => 'existing',
        }),
      }
    }

    $cluster_nodes.each |$node| {
      k8s::server::etcd::member { $node['parameters']['etcd_name']:
        peer_urls    => $node['parameters']['initial_advertise_peer_urls'],
        cluster_urls => ['https://localhost:2379'],
        cluster_ca   => $client_ca_cert,
        cluster_cert => "${cert_path}/etcd-client.pem",
        cluster_key  => "${cert_path}/etcd-client.key",
      }
    }
  }

  if $manage_firewall {
    if $facts['firewalld_version'] {
      $_firewall_type = pick($firewall_type, 'firewalld')
    } else {
      $_firewall_type = pick($firewall_type, 'iptables')
    }

    case $_firewall_type {
      'firewalld' : {
        firewalld_service {
          default:
            ensure => $ensure,
            zone   => 'public';

          'Allow etcd server access':
            service => 'etcd-server';

          'Allow etcd client access':
            service => 'etcd-client';
        }
      }
      'iptables': {
        include firewall

        firewall { '100 allow etcd server access':
          dport  => 2379,
          proto  => 'tcp',
          action => 'accept',
        }
        firewall { '100 allow etcd client access':
          dport  => 2380,
          proto  => 'tcp',
          action => 'accept',
        }
      }
      default: {}
    }
  }
}