Puppet Class: k8s

Defined in:
manifests/init.pp

Summary

Sets up a Kubernetes instance - either as a node or as a server

Overview

Parameters:

  • manage_kernel_modules (Boolean) (defaults to: true)

    A flag to manage required Kernel modules.

  • manage_sysctl_settings (Boolean) (defaults to: true)

    A flag to manage required sysctl settings.

  • manage_kube_proxy (K8s::Proxy_method) (defaults to: true)

    How/if the kube-proxy component should be managed, either as an in-cluster component (default), or as an on-node component for advanced use-cases.

  • ensure (K8s::Ensure) (defaults to: 'present')
  • packaging (Enum['container', 'native']) (defaults to: 'native')
  • user (String[1]) (defaults to: 'kube')

    username for kubernetes files and services

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

    groupname for kubernetes files and services

  • uid (Integer[0, 65535]) (defaults to: 888)

    user id for kubernetes files and services

  • gid (Integer[0, 65535]) (defaults to: 888)

    group id for kubernetes files and services

  • etcd_cluster_name (String[1]) (defaults to: 'default')

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

  • native_packaging (K8s::Native_packaging) (defaults to: 'loose')
  • version (String[1]) (defaults to: '1.26.1')
  • etcd_version (String[1]) (defaults to: '3.5.1')
  • container_registry (String[1]) (defaults to: 'registry.k8s.io')
  • container_image_tag (Optional[String[1]]) (defaults to: undef)
  • container_manager (K8s::Container_runtimes) (defaults to: 'crio')
  • container_runtime_service (String[1]) (defaults to: "${container_manager}.service")
  • crio_package (Optional[String[1]]) (defaults to: undef)
  • containerd_package (Optional[String[1]]) (defaults to: undef)
  • crictl_package (Optional[String[1]]) (defaults to: undef)
  • runc_version (String[1]) (defaults to: 'installed')
  • manage_etcd (Boolean) (defaults to: true)
  • manage_firewall (Boolean) (defaults to: false)
  • manage_image (Boolean) (defaults to: false)
  • manage_repo (Boolean) (defaults to: true)
  • manage_packages (Boolean) (defaults to: true)
  • manage_container_manager (Boolean) (defaults to: true)
  • puppetdb_discovery (Boolean) (defaults to: false)
  • puppetdb_discovery_tag (String[1]) (defaults to: 'default')
  • purge_manifests (Boolean) (defaults to: true)
  • native_url_template (String[1]) (defaults to: 'https://storage.googleapis.com/kubernetes-release/release/v%{version}/bin/%{kernel}/%{arch}/%{binary}')
  • tarball_url_template (String[1]) (defaults to: 'https://dl.k8s.io/v%{version}/kubernetes-%{component}-%{kernel}-%{arch}.tar.gz')
  • package_template (String[1]) (defaults to: 'kubernetes-%{component}')
  • hyperkube_name (String[1]) (defaults to: 'hyperkube')
  • sysconfig_path (Optional[Stdlib::Unixpath]) (defaults to: undef)
  • node_auth (K8s::Node_auth) (defaults to: 'bootstrap')
  • incluster_control_plane_url (Stdlib::HTTPUrl) (defaults to: 'https://kubernetes.default.svc')
  • control_plane_url (Stdlib::HTTPUrl) (defaults to: 'https://kubernetes:6443')
  • service_cluster_cidr (K8s::CIDR) (defaults to: '10.1.0.0/24')
  • cluster_cidr (K8s::CIDR) (defaults to: '10.0.0.0/16')
  • api_service_address (Stdlib::IP::Address::Nosubnet) (defaults to: k8s::ip_in_cidr($service_cluster_cidr, 'first'))
  • dns_service_address (K8s::IP_addresses) (defaults to: k8s::ip_in_cidr($service_cluster_cidr, 'second'))
  • cluster_domain (Stdlib::Fqdn) (defaults to: 'cluster.local')
  • role (Enum['node','server','none']) (defaults to: 'none')
  • firewall_type (Optional[K8s::Firewall]) (defaults to: undef)


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
# File 'manifests/init.pp', line 21

class k8s (
  K8s::Ensure $ensure                     = 'present',
  Enum['container', 'native'] $packaging  = 'native',
  K8s::Native_packaging $native_packaging = 'loose',
  String[1] $version                      = '1.26.1',
  String[1] $etcd_version                 = '3.5.1',

  String[1] $container_registry              = 'registry.k8s.io',
  Optional[String[1]] $container_image_tag   = undef,

  K8s::Container_runtimes $container_manager = 'crio',
  String[1] $container_runtime_service       = "${container_manager}.service",
  Optional[String[1]] $crio_package          = undef,
  Optional[String[1]] $containerd_package    = undef,
  Optional[String[1]] $crictl_package        = undef,
  String[1] $runc_version                    = 'installed',

  Boolean $manage_etcd                 = true,
  Boolean $manage_firewall             = false,
  Boolean $manage_kernel_modules       = true,
  Boolean $manage_sysctl_settings      = true,
  Boolean $manage_image                = false,
  Boolean $manage_repo                 = true,
  Boolean $manage_packages             = true,
  Boolean $manage_container_manager    = true,
  K8s::Proxy_method $manage_kube_proxy = true,

  Boolean $puppetdb_discovery       = false,
  String[1] $puppetdb_discovery_tag = 'default',

  Boolean $purge_manifests = true,

  String[1] $native_url_template             = 'https://storage.googleapis.com/kubernetes-release/release/v%{version}/bin/%{kernel}/%{arch}/%{binary}',
  String[1] $tarball_url_template            = 'https://dl.k8s.io/v%{version}/kubernetes-%{component}-%{kernel}-%{arch}.tar.gz',
  String[1] $package_template                = 'kubernetes-%{component}',
  String[1] $hyperkube_name                  = 'hyperkube',
  Optional[Stdlib::Unixpath] $sysconfig_path = undef,

  K8s::Node_auth $node_auth = 'bootstrap',

  Stdlib::HTTPUrl $incluster_control_plane_url       = 'https://kubernetes.default.svc',
  Stdlib::HTTPUrl $control_plane_url                 = 'https://kubernetes:6443',
  K8s::CIDR $service_cluster_cidr                    = '10.1.0.0/24',
  K8s::CIDR $cluster_cidr                            = '10.0.0.0/16',
  Stdlib::IP::Address::Nosubnet $api_service_address = k8s::ip_in_cidr($service_cluster_cidr, 'first'),
  K8s::IP_addresses $dns_service_address             = k8s::ip_in_cidr($service_cluster_cidr, 'second'),
  Stdlib::Fqdn $cluster_domain                       = 'cluster.local',
  String[1] $etcd_cluster_name                       = 'default',

  Enum['node','server','none']  $role    = 'none',
  Optional[K8s::Firewall] $firewall_type = undef,

  String[1] $user        = 'kube',
  String[1] $group       = 'kube',
  Integer[0, 65535] $uid = 888,
  Integer[0, 65535] $gid = 888,
) {
  if $manage_container_manager {
    include k8s::install::container_runtime
  }

  group { $group:
    ensure => present,
    system => true,
    gid    => $gid,
  }

  user { $user:
    ensure     => present,
    comment    => 'Kubernetes user',
    gid        => $group,
    home       => '/srv/kubernetes',
    managehome => false,
    shell      => (fact('os.family') ? {
        'Debian' => '/usr/sbin/nologin',
        default  => '/sbin/nologin',
    }),
    system     => true,
    uid        => $uid,
  }

  file {
    default:
      ensure  => directory,
      force   => true,
      purge   => true,
      recurse => true;

    '/opt/k8s': ;
    '/opt/k8s/bin': ;
  }

  file { '/var/run/kubernetes':
    ensure => directory,
    owner  => $user,
    group  => $group,
  }

  $_sysconfig_path = pick($sysconfig_path, '/etc/sysconfig')
  file { "${_sysconfig_path}/kube-common":
    ensure  => file,
    content => epp('k8s/sysconfig.epp', {
        comment               => 'General Kubernetes Configuration',
        environment_variables => {
          'KUBE_LOG_LEVEL'   => '',
        },
    }),
  }

  file {
    default:
      ensure => directory;

    '/etc/kubernetes': ;
    '/etc/kubernetes/certs': ;
    '/etc/kubernetes/manifests':
      purge   => $purge_manifests,
      recurse => true;
    '/root/.kube': ;
    '/srv/kubernetes':
      owner => $user,
      group => $group;
    '/usr/libexec/kubernetes': ;
    '/var/lib/kubelet': ;
    '/var/lib/kubelet/pki': ;

    '/usr/share/containers/': ;
    '/usr/share/containers/oci/': ;
    '/usr/share/containers/oci/hooks.d': ;
  }

  if $manage_repo {
    include k8s::repo
  }

  if $manage_packages {
    # Ensure conntrack is installed to properly handle networking cleanup
    if fact('os.family') == 'Debian' {
      $_conntrack = 'conntrack'
    } else {
      $_conntrack = 'conntrack-tools'
    }

    ensure_packages([$_conntrack,])
  }

  include k8s::install::cni_plugins

  if $role == 'server' {
    include k8s::server
  } elsif $role == 'node' {
    include k8s::node
  }
}