Class: Pfab::Templates::Web

Inherits:
LongRunningProcess show all
Defined in:
lib/pfab/templates/web.rb

Instance Method Summary collapse

Methods inherited from LongRunningProcess

#default_probe, #livenessProbe, #probes, #readinessProbe, #rolling_update_strategy, #startupProbe

Methods inherited from Base

#app_vars, #container_ports, #cpu, #deploy_id, #deploy_unique_id, #env_from, #env_vars, #get, #get_command, #get_namespace, #image_name, #initialize, #load_env_vars, #load_secrets, #memory, #resources

Constructor Details

This class inherits a constructor from Pfab::Templates::Base

Instance Method Details

#application_type ⇒ Object 



149
150
151
 
# File 'lib/pfab/templates/web.rb', line 149

def application_type
  "web"
end

#deployment ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/pfab/templates/web.rb', line 221

def deployment
  secret_mounts = get("secretMounts") || []
  volume_mounts = []
  volumes = []
  secret_mounts.each do |secret_mount|
    volumes.append({
                     name: secret_mount['name'],
                     secret: { secretName: secret_mount['secretName'] }
                   })
    volume_mounts.append({
                           name: secret_mount['name'],
                           mountPath: secret_mount['path'],
                           readOnly: secret_mount['readOnly'] || true
                         })
  end

  if get("datadogVolumeMountEnabled")
    datadog_volume_name = "ddsocket"
    datadog_path = "/var/run/datadog"
    volumes.append({
                     name: datadog_volume_name,
                     hostPath: {
                      path: datadog_path
                     }
                   })
    volume_mounts.append(
      name: datadog_volume_name,
      mountPath: datadog_path,
      readOnly: true
    )
  end
  ports = container_ports()


  {
    kind: "Deployment",
    apiVersion: "apps/v1",
    metadata: {
      name: @data['deployed_name'],
      namespace: get_namespace,
      labels: {
        "application" => @data['application'],
        "deployed-name" => @data['deployed_name'],
        "application-type" => application_type,
        "deploy-id" => deploy_id,
        LABEL_DEPLOY_UNIQUE_ID => StyledYAML.double_quoted(deploy_unique_id),
        "tags.datadoghq.com/env" => @data['env'],
        "tags.datadoghq.com/service" => @data['deployed_name'],
        "tags.datadoghq.com/version" => StyledYAML.double_quoted(@data['sha'])
      }
    },
    spec: {
      replicas: get("replicas") || 1,
      selector: {
        matchLabels: {
          "deployed-name" => @data['deployed_name'],
        },
      },
      strategy: rolling_update_strategy,
      revisionHistoryLimit: 5,
      progressDeadlineSeconds: get("progressDeadlineSeconds") || 600,
      template: {
        metadata: {
          labels: {
            application: @data['application'],
            "deployed-name" => @data['deployed_name'],
            "application-type" => "web",
            LABEL_DEPLOY_UNIQUE_ID => StyledYAML.double_quoted(deploy_unique_id),
            "tags.datadoghq.com/env": @data['env'],
            "tags.datadoghq.com/service": @data['deployed_name'],
            "tags.datadoghq.com/version": StyledYAML.double_quoted(@data['sha'])
          },
        },
        spec: {
          serviceAccountName: get('serviceAccountName'),
          terminationGracePeriodSeconds: get("terminationGracePeriodSeconds") || 30,
          containers: [
            {
              image: image_name,
              name: @data['deployed_name'],
              command: get_command,
              env: env_vars,
              envFrom: env_from,
              resources: resources,
              ports: ports,
              lifecycle: lifecycle,
              volumeMounts: volume_mounts
            }.merge(probes()).compact
          ],
          topologySpreadConstraints: get_replica_count > 1 ? topology_spread_constraints : [],
          volumes: volumes
        }.compact,
      },
    }.compact,
  }.compact
end

#get_replica_count ⇒ Object 



8
9
10
11
 
# File 'lib/pfab/templates/web.rb', line 8

def get_replica_count
  raw_replicas = get("replicas")
  raw_replicas ? raw_replicas.to_i : 1
end

#hosts ⇒ Object 



101
102
103
 
# File 'lib/pfab/templates/web.rb', line 101

def hosts
  get("host").split(",")
end

#ingres_enabled? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
33
34
35
 
# File 'lib/pfab/templates/web.rb', line 30

def ingres_enabled?
  if not app_vars.has_key?('generateIngressEnabled') || app_vars['generateIngressEnabled']
    return true
  end
  return false
end

#ingress ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/pfab/templates/web.rb', line 72

def ingress
  {
    apiVersion: "networking.k8s.io/v1",
    kind: "Ingress",
    metadata: {
      name: "ingress-#{@data['deployed_name']}",
      namespace: get_namespace,
      labels: {
        application: @data['application'],
        "deployed-name" => @data['deployed_name'],
      },
      annotations: ingress_annotations,
    },
    spec: {
      rules: rules,
      tls: tls_hosts
    },
  }
end

#ingress_annotations ⇒ Object 



129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/pfab/templates/web.rb', line 129

def ingress_annotations
  h = {
    "kubernetes.io/ingress.class" => "traefik",
    "traefik.frontend.passHostHeader" => "false",
    "traefik.frontend.priority" => "1",
    "traefik.frontend.entryPoints" => "https",
    "traefik.protocol" => get("protocol") || "http",
    "traefik.frontend.headers.SSLRedirect" => "true",
    "traefik.docker.network" => "traefik",
    "traefik.ingress.kubernetes.io/router.entrypoints" => "websecure",
    "traefik.ingress.kubernetes.io/router.tls" => "true"
  }
  h
end

#labelSelector ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/pfab/templates/web.rb', line 199

def labelSelector
  {
    matchExpressions: [
    {
      key: "deployed-name",
      operator: "In",
      values: [
        @data['deployed_name']
      ]
    },
    {
      key: LABEL_DEPLOY_UNIQUE_ID,
      operator: "In",
      values: [
        StyledYAML.double_quoted(deploy_unique_id)
      ]
    }
  ]
  }
end

#lifecycle ⇒ Object 



144
145
146
 
# File 'lib/pfab/templates/web.rb', line 144

def lifecycle
  get("lifecycle")
end

#pod_disruption_budget ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/pfab/templates/web.rb', line 153

def pod_disruption_budget
  pdb = {
    apiVersion: "policy/v1",
    kind: "PodDisruptionBudget",
    metadata:  {
      name: "#{@data['deployed_name']}-pdb",
      namespace: get_namespace()
    },
    spec: {
      minAvailable: 1,
      selector: {
      matchLabels: {
        application: @data['application'],
        "deployed-name" => @data['deployed_name'],
        "application-type" => application_type
        }
      }
    }
  }
  return pdb
end

#rules ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/pfab/templates/web.rb', line 105

def rules
  hosts.map do |host|
    {
      host: host,
      http: {
        paths: [
          {
            path: "/",
            pathType: "Prefix",
            backend: {
              service: {
                name: @data['deployed_name'],
                port: {
                  name: "http"
                }
              }
            },
          },
        ],
      },
    }
  end
end

#service ⇒ Object 



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
 
# File 'lib/pfab/templates/web.rb', line 37

def service
  {
    apiVersion: "v1",
    kind: "Service",
    metadata: {
      name: @data['deployed_name'],
      namespace: get_namespace,
      labels: {
        application: @data['application'],
        "deployed-name" => @data['deployed_name'],
      },
      annotations: service_annotations,
    },
    spec: {
      selector: {
        "deployed-name" => @data['deployed_name'],
      },
      ports: [
        {
          name: "http",
          port: app_vars["service_listen_port"] || 80,
          targetPort: app_vars["port"],
          appProtocol: app_vars["appProtocol"]
        }.compact
      ]
    }
  }
end

#service_annotations ⇒ Object 



66
67
68
69
70
 
# File 'lib/pfab/templates/web.rb', line 66

def service_annotations
  h = {}
  h["traefik.ingress.kubernetes.io/service.serversscheme"] = "h2c" if get("protocol") == "h2c"
  h
end

#tls_hosts ⇒ Object 



92
93
94
95
96
97
98
99
 
# File 'lib/pfab/templates/web.rb', line 92

def tls_hosts
  hosts.map do |host|
    {
      hosts: [host],
      secretName: get("tls_cert_secret")
    }
  end
end

#topology_spread_constraints ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/pfab/templates/web.rb', line 176

def topology_spread_constraints
  waiveTopologySpreadConstraints = get("waiveTopologySpreadConstraints") || false

  schedulingRule = waiveTopologySpreadConstraints ? "ScheduleAnyway" : "DoNotSchedule"

  zone_constraint = {
    maxSkew: 1,
    topologyKey: "topology.kubernetes.io/zone",
    whenUnsatisfiable: schedulingRule,
    labelSelector: labelSelector
  }
  host_constraint = {
    maxSkew: 1,
    topologyKey: "kubernetes.io/hostname",
    whenUnsatisfiable: schedulingRule,
    labelSelector: labelSelector

  }
  [zone_constraint, host_constraint]
end

#write_to(f) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/pfab/templates/web.rb', line 13

def write_to(f)
  if ingres_enabled? && get("host").nil?
    puts "No host to configure ingress for #{@data['deployed_name']}. Skipping deployment. add a host or generateIngressEnabled:false"
  else
    f << StyledYAML.dump(service.deep_stringify_keys)
    if ingres_enabled?
      f << StyledYAML.dump(ingress.deep_stringify_keys)
    else
      puts "skipping ingress because ingress_disabled = #{@data['generateIngressEnabled']}"
    end
    f << StyledYAML.dump(deployment.deep_stringify_keys)
    if get_replica_count() > 1
      f << StyledYAML.dump(pod_disruption_budget.deep_stringify_keys)
    end
  end
end