Class: KuberKit::Core::ConfigurationDefinition

Inherits:
Object
  • Object
show all
Defined in:
lib/kuber_kit/core/configuration_definition.rb

Constant Summary collapse

ResourceAlreadyAdded =
Class.new(KuberKit::Error)

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(configuration_name) ⇒ ConfigurationDefinition

Returns a new instance of ConfigurationDefinition.



7
8
9
10
11
12
13
14
15
16
17
18
19
# File 'lib/kuber_kit/core/configuration_definition.rb', line 7

def initialize(configuration_name)
  @configuration_name = configuration_name.to_sym
  @artifacts  = {}
  @registries = {}
  @env_files  = {}
  @templates  = {}
  @build_servers      = []
  @enabled_services   = []
  @disabled_services  = []
  @default_services   = []
  @initial_services   = []
  @services_attributes = {}
end

Instance Attribute Details

#configuration_nameObject (readonly)

Returns the value of attribute configuration_name.



4
5
6
# File 'lib/kuber_kit/core/configuration_definition.rb', line 4

def configuration_name
  @configuration_name
end

Instance Method Details

#default_services(services) ⇒ Object



140
141
142
143
# File 'lib/kuber_kit/core/configuration_definition.rb', line 140

def default_services(services)
  @default_services += services.map(&:to_sym)
  return self
end

#deployer_namespace(namespace) ⇒ Object



100
101
102
103
104
# File 'lib/kuber_kit/core/configuration_definition.rb', line 100

def deployer_namespace(namespace)
  @deployer_namespace = namespace

  self
end

#deployer_require_confirmationObject Also known as: deployer_require_confirimation



112
113
114
115
116
# File 'lib/kuber_kit/core/configuration_definition.rb', line 112

def deployer_require_confirmation
  @deployer_require_confirmation = true

  self
end

#deployer_strategy(strategy) ⇒ Object



106
107
108
109
110
# File 'lib/kuber_kit/core/configuration_definition.rb', line 106

def deployer_strategy(strategy)
  @deployer_strategy = strategy

  self
end

#disabled_services(services) ⇒ Object



150
151
152
153
# File 'lib/kuber_kit/core/configuration_definition.rb', line 150

def disabled_services(services)
  @disabled_services += services.map(&:to_sym)
  return self
end

#enabled_services(services) ⇒ Object

Raises:



125
126
127
128
129
130
131
132
133
134
135
136
137
138
# File 'lib/kuber_kit/core/configuration_definition.rb', line 125

def enabled_services(services)
  if services.is_a?(Hash)
    @enabled_services += services.keys.map(&:to_sym)
    @services_attributes = @services_attributes.merge(services)
    return self
  end

  if services.is_a?(Array)
    @enabled_services += services.map(&:to_sym)
    return self
  end

  raise KuberKit::Error, "#enabled_services method accepts only Array or Hash"
end

#global_build_vars(variables) ⇒ Object



160
161
162
163
164
# File 'lib/kuber_kit/core/configuration_definition.rb', line 160

def global_build_vars(variables)
  @global_build_vars = variables

  self
end

#initial_services(services) ⇒ Object



145
146
147
148
# File 'lib/kuber_kit/core/configuration_definition.rb', line 145

def initial_services(services)
  @initial_services += services.map(&:to_sym)
  return self
end

#kubeconfig_path(path) ⇒ Object



88
89
90
91
92
# File 'lib/kuber_kit/core/configuration_definition.rb', line 88

def kubeconfig_path(path)
  @kubeconfig_path = path

  self
end

#kubectl_entrypoint(path) ⇒ Object



94
95
96
97
98
# File 'lib/kuber_kit/core/configuration_definition.rb', line 94

def kubectl_entrypoint(path)
  @kubectl_entrypoint = path

  self
end

#service_attributes(services) ⇒ Object



155
156
157
158
# File 'lib/kuber_kit/core/configuration_definition.rb', line 155

def service_attributes(services)
  @services_attributes = @services_attributes.merge(services)
  self
end

#shell_launcher_strategy(strategy) ⇒ Object



119
120
121
122
123
# File 'lib/kuber_kit/core/configuration_definition.rb', line 119

def shell_launcher_strategy(strategy)
  @shell_launcher_strategy = strategy

  self
end

#to_attrsObject



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# File 'lib/kuber_kit/core/configuration_definition.rb', line 21

def to_attrs
  OpenStruct.new(
    name:                 @configuration_name,
    artifacts:            @artifacts,
    registries:           @registries,
    env_files:            @env_files,
    templates:            @templates,
    kubeconfig_path:      @kubeconfig_path,
    kubectl_entrypoint:   @kubectl_entrypoint,
    enabled_services:     @enabled_services,
    disabled_services:    @disabled_services,
    default_services:     @default_services,
    initial_services:     @initial_services,
    build_servers:        @build_servers,
    services_attributes:  @services_attributes,
    global_build_vars:    @global_build_vars,
    deployer_strategy:              @deployer_strategy,
    deployer_namespace:             @deployer_namespace,
    deployer_require_confirmation:  @deployer_require_confirmation || false,
    shell_launcher_strategy:        @shell_launcher_strategy,
  )
end

#use_artifact(artifact_name, as:) ⇒ Object



44
45
46
47
48
49
50
51
# File 'lib/kuber_kit/core/configuration_definition.rb', line 44

def use_artifact(artifact_name, as:)
  if @artifacts.has_key?(as)
    raise ResourceAlreadyAdded.new("alias name :#{as} is already used by artifact: #{@artifacts[as].inspect}")
  end
  @artifacts[as] = artifact_name

  self
end

#use_build_server(build_server_name) ⇒ Object



80
81
82
83
84
85
86
# File 'lib/kuber_kit/core/configuration_definition.rb', line 80

def use_build_server(build_server_name)
  unless @build_servers.include?(build_server_name)
    @build_servers.push(build_server_name)
  end

  self
end

#use_env_file(env_file_name, as:) ⇒ Object



62
63
64
65
66
67
68
69
# File 'lib/kuber_kit/core/configuration_definition.rb', line 62

def use_env_file(env_file_name, as:)
  if @env_files.has_key?(as)
    raise ResourceAlreadyAdded.new("alias name :#{as} is already used by env_file: #{@env_files[as].inspect}")
  end
  @env_files[as] = env_file_name

  self
end

#use_registry(registry_name, as:) ⇒ Object



53
54
55
56
57
58
59
60
# File 'lib/kuber_kit/core/configuration_definition.rb', line 53

def use_registry(registry_name, as:)
  if @registries.has_key?(as)
    raise ResourceAlreadyAdded.new("alias name :#{as} is already used by registry: #{@registries[as].inspect}")
  end
  @registries[as] = registry_name

  self
end

#use_template(template_name, as:) ⇒ Object



71
72
73
74
75
76
77
78
# File 'lib/kuber_kit/core/configuration_definition.rb', line 71

def use_template(template_name, as:)
  if @templates.has_key?(as)
    raise ResourceAlreadyAdded.new("alias name :#{as} is already used by template: #{@templates[as].inspect}")
  end
  @templates[as] = template_name

  self
end