Class: Metatron::Template

Inherits:

Object

• Object
• Metatron::Template

Defined in:

lib/metatron/template.rb

Overview

Base class for templating Kubernetes resources

Direct Known Subclasses

Metatron::Templates::ClusterRole, Metatron::Templates::ClusterRoleBinding, Metatron::Templates::ConfigMap, Metatron::Templates::CronJob, Metatron::Templates::DaemonSet, Metatron::Templates::Deployment, Metatron::Templates::Ingress, Metatron::Templates::Job, Metatron::Templates::Namespace, Metatron::Templates::NetworkPolicy, Metatron::Templates::PersistentVolumeClaim, Metatron::Templates::Pod, Metatron::Templates::ReplicaSet, Metatron::Templates::Role, Metatron::Templates::RoleBinding, Metatron::Templates::Secret, Metatron::Templates::Service, Metatron::Templates::ServiceAccount, Metatron::Templates::StatefulSet

Class Attribute Summary

• .label_namespace ⇒ Object

Instance Attribute Summary

• #additional_labels ⇒ Object

  Returns the value of attribute additional_labels.

• #api_version ⇒ Object (also: #apiVersion)

  Returns the value of attribute api_version.

• #kind ⇒ Object readonly

  Returns the value of attribute kind.

• #label_namespace ⇒ Object readonly

  Returns the value of attribute label_namespace.

• #name ⇒ Object

  Returns the value of attribute name.

Class Method Summary

• .initializer(*args) ⇒ Object
• .initializers ⇒ Object
• .metatron_template_class? ⇒ Boolean
• .nearest_metatron_ancestor ⇒ Object

Instance Method Summary

• #base_labels ⇒ Object
• #initialize(name) ⇒ Template constructor

  A new instance of Template.

Constructor Details

#initialize(name) ⇒ Template

Returns a new instance of Template.

# File 'lib/metatron/template.rb', line 39

def initialize(name)
  @name = name
  @label_namespace = self.class.label_namespace
  @api_version = "v1"
  @kind = find_kind
  @additional_labels = {}
  run_initializers
end

Class Attribute Details

.label_namespace ⇒ Object

# File 'lib/metatron/template.rb', line 12

def label_namespace
  @label_namespace ||= "metatron.therubyist.org"
end

Instance Attribute Details

#additional_labels ⇒ Object

Returns the value of attribute additional_labels.

# File 'lib/metatron/template.rb', line 6

def additional_labels
  @additional_labels
end

#api_version ⇒ Object Also known as: apiVersion

Returns the value of attribute api_version.

# File 'lib/metatron/template.rb', line 6

def api_version
  @api_version
end

#kind ⇒ Object (readonly)

Returns the value of attribute kind.

# File 'lib/metatron/template.rb', line 7

def kind
  @kind
end

#label_namespace ⇒ Object (readonly)

Returns the value of attribute label_namespace.

# File 'lib/metatron/template.rb', line 7

def label_namespace
  @label_namespace
end

#name ⇒ Object

Returns the value of attribute name.

# File 'lib/metatron/template.rb', line 6

def name
  @name
end

Class Method Details

.initializer(*args) ⇒ Object

# File 'lib/metatron/template.rb', line 16

def initializer(*args)
  @initializers ||= []
  @initializers += args
end

.initializers ⇒ Object

# File 'lib/metatron/template.rb', line 21

def initializers
  @initializers ||= []
end

.metatron_template_class? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/metatron/template.rb', line 31

def metatron_template_class?
  return true if name == "Metatron::Template"
  return false if name.start_with?("Metatron::Templates::Concerns")

  name.start_with?("Metatron::Templates::")
end

.nearest_metatron_ancestor ⇒ Object

# File 'lib/metatron/template.rb', line 25

def nearest_metatron_ancestor
  return self if metatron_template_class?

  ancestors.find { _1.respond_to?(:metatron_template_class?) && _1.metatron_template_class? }
end

Instance Method Details

#base_labels ⇒ Object

# File 'lib/metatron/template.rb', line 50

def base_labels = { "#{label_namespace}/name": name }