› kube_cluster › Source › Kube › Cluster › Middleware

class Middleware

Base class for manifest middleware.

Example: Transform: mutate resources in place

class AddTeamLabel < Middleware
  def call(manifest)
    manifest.resources.map! do |resource|
      h = resource.to_h
      h[:metadata][:labels][:"app.kubernetes.io/team"] = "platform"
      resource.rebuild(h)
    end
  end
end

Example: Generative: add new resources to the manifest

class ServiceForDeployment < Middleware
  def call(manifest)
    generated = []
    manifest.resources.each do |resource|
      next unless resource.pod_bearing?
      generated << build_service_from(resource)
    end
    manifest.resources.concat(generated)
  end
end

Signature

Nested

Definitions

def self.build(**defaults, &block)

Build an anonymous Middleware subclass from a block.

Example.

Middleware.build(filter: ->(r) { r.pod_bearing? }) do |manifest|
  manifest.resources.map! do |resource|
    filter(resource) do
      h = resource.to_h
      h[:metadata][:labels][:custom] = "yes"
      resource.rebuild(h)
    end
  end
end

Signature

parameter defaults Hash

baked-in filter/opts for #initialize.

yields {|manifest| ...}

the block becomes #call, via instance_exec.

returns Class

a Middleware subclass.

Implementation

def self.build(**defaults, &block)
  Class.new(self) do
    define_method(:initialize) do |**overrides|
      super(**defaults, **overrides)
    end

    define_method(:call, &block)
  end
end

def call(manifest)

Override in subclasses to mutate the manifest in place.

Signature

parameter manifest Manifest

the full manifest to mutate.

Implementation

def call(manifest)
end