› kube_cluster › Source › Kube › Cluster › Middleware › Stack

class Stack

An ordered pipeline of middleware that processes a manifest.

stack.call(manifest)

Example.

stack = Kube::Cluster::Middleware::Stack.new do
  use Middleware::ServiceForDeployment
  use Middleware::Labels, app: "web"
  use Middleware::SetNamespace, "production"
end

Signature

Definitions

def use(klass, *args, **kwargs)

Register a middleware class to run in the stack.

Signature

parameter klass Class

a Middleware subclass.

parameter args Array

positional arguments for #new.

parameter kwargs Hash

keyword arguments for #new.

Implementation

def use(klass, *args, **kwargs)
  @middleware << [klass, args, kwargs]
end

def call(manifest)

Runs the manifest through every middleware, in order.

Signature

parameter manifest Manifest

the manifest to mutate.

Implementation

def call(manifest)
  @middleware.each do |klass, args, kwargs|
    klass.new(*args, **kwargs).call(manifest)
  end
end

def run(manifest)

Runs the manifest through the stack, then emits YAML.

Example: Called inside the Stack block as the final step

Middleware::Stack.new {
  use SetNamespace
  run manifest
}

Signature

parameter manifest Manifest

the manifest to mutate and emit.

Implementation

def run(manifest)
  call(manifest)
  puts manifest.to_yaml
end

def empty?

Signature

returns Boolean

true when no middleware has been registered.

Implementation

def empty?
  @middleware.empty?
end