Class: HelmWrapper::Shared::Runner

Inherits:
Object
  • Object
show all
Includes:
Logging
Defined in:
lib/helm-wrapper/shared/runner.rb

Constant Summary collapse

@@repo_actions = 
[ "registry", "repo" ]

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Logging

configure_logger_for, logger_for

Constructor Details

#initialize(binary:, chart:, config: nil) ⇒ Runner

Returns a new instance of Runner.



39
40
41
42
43
44
45
46
 
# File 'lib/helm-wrapper/shared/runner.rb', line 39

def initialize(binary:, chart:, config: nil)
  @binary = binary
  @chart  = chart
  @config = config

  @auths = false
  @repos = false
end

Instance Attribute Details

#auths ⇒ Object (readonly)

Returns the value of attribute auths.



31
32
33
 
# File 'lib/helm-wrapper/shared/runner.rb', line 31

def auths
  @auths
end

#binary ⇒ Object (readonly)

Returns the value of attribute binary.



32
33
34
 
# File 'lib/helm-wrapper/shared/runner.rb', line 32

def binary
  @binary
end

#chart ⇒ Object (readonly)

Returns the value of attribute chart.



33
34
35
 
# File 'lib/helm-wrapper/shared/runner.rb', line 33

def chart
  @chart
end

#config ⇒ Object (readonly)

Returns the value of attribute config.



34
35
36
 
# File 'lib/helm-wrapper/shared/runner.rb', line 34

def config
  @config
end

#repos ⇒ Object (readonly)

Returns the value of attribute repos.



35
36
37
 
# File 'lib/helm-wrapper/shared/runner.rb', line 35

def repos
  @repos
end

Instance Method Details

#clean(repos: true) ⇒ Object 



110
111
112
113
 
# File 'lib/helm-wrapper/shared/runner.rb', line 110

def clean(repos: true)
  clean_repos if repos
  clean_auths if @auths_attempted
end

#delete ⇒ Object 



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/helm-wrapper/shared/runner.rb', line 117

def delete()
  logger.fatal("Cannot Helm delete without a valid configuration!") if @config.nil?
  logger.fatal("Cannot Helm delete before initialising authenticators!") unless auths

  parameters = Array.new
  parameters.append("--namespace=\"#{@config.namespace}\"")
  parameters.append("\"#{@config.release}\"")

  logger.fatal("Helm delete failed!") unless run(action: "delete", parameters: parameters)
end

#init_auths ⇒ Object 



50
51
52
53
54
55
56
57
58
 
# File 'lib/helm-wrapper/shared/runner.rb', line 50

def init_auths()
  logger.fatal("Cannot initialise authenticators without a valid configuration!") if @config.nil?

  @auths_attempted = true

  config.auths.map(&:auth)

  @auths = true
end

#init_repos(force: false) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/helm-wrapper/shared/runner.rb', line 62

def init_repos(force: false)
  ENV["HELM_EXPERIMENTAL_OCI"] = "true"

  @chart.oci.each_with_index do |oci_repo, oci_index|
    logger.info("Logging into OCI repository: #{oci_repo["name"]}")

    username = from_environment(variable: oci_repo["username"])
    password = from_environment(variable: oci_repo["password"])

    @chart.oci_active(active: true, index: oci_index)

    parameters = Array.new
    parameters.append("login")
    parameters.append("\"#{oci_repo["url"]}\"")
    parameters.append("--username=\"#{username}\"")
    parameters.append("--password-stdin")
    logger.fatal("Failed to login to Helm OCI repository: #{oci_repo["name"]}, url: #{oci_repo["url"]}") unless run(action: "registry", parameters: parameters, stdin: password)
  end

  if @chart.artefact.length > 0 then

    @chart.artefact.each_with_index do |artefact_repo, artefact_index|
      logger.info("Adding artefact repository: #{artefact_repo["name"]}")

      username = artefact_repo["username"].nil? ? nil : from_environment(variable: artefact_repo["username"])
      password = artefact_repo["password"].nil? ? nil : from_environment(variable: artefact_repo["password"])

      @chart.artefact_active(active: true, index: artefact_index)

      parameters = Array.new
      parameters.append("add")
      parameters.append("\"#{artefact_repo["name"]}\"")
      parameters.append("\"#{artefact_repo["url"]}\"")
      parameters.append("--username=\"#{username}\"") unless username.nil?
      parameters.append("--password=\"#{password}\"") unless password.nil?
      parameters.append("--force-update") if force
      logger.fatal("Failed to add Helm repository: #{artefact_repo["name"]}, url: #{artefact_repo["url"]}") unless run(action: "repo", parameters: parameters)
    end

    logger.info("Updating artefact repositories...")
    logger.fatal("Failed to update Helm artefact repositories!") unless run(action: "repo", parameters: Array.new([ "update" ]))
  end

  @repos = true
end

#lint ⇒ Object 



169
170
171
172
173
174
 
# File 'lib/helm-wrapper/shared/runner.rb', line 169

def lint()
  parameters = Array.new
  parameters.append("\"#{@chart.path}\"")

  logger.fatal("Helm validate failed!") unless run(action: "lint", parameters: parameters)
end

#package(destination: ".") ⇒ Object 



178
179
180
181
182
183
184
 
# File 'lib/helm-wrapper/shared/runner.rb', line 178

def package(destination: ".")
  parameters = Array.new
  parameters.append("--destination=\"#{destination}\"")
  parameters.append("\"#{@chart.path}\"")

  logger.fatal("Helm package failed!") unless run(action: "package", parameters: parameters)
end

#push(source: ".", destination:) ⇒ Object 



188
189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/helm-wrapper/shared/runner.rb', line 188

def push(source: ".", destination:)
  logger.fatal("Cannot Helm push before initialising repositories!") unless repos

  package_name = "#{@chart.name}-#{@chart.version}.tgz"
  package_path = File.join(source, package_name)

  logger.fatal("Must package before pushing! Package: #{package_path} not found!") unless File.file?(package_path)

  parameters = Array.new
  parameters.append("\"#{package_path}\"")
  parameters.append("\"#{destination}\"")

  logger.fatal("Helm push failed!") unless run(action: "push", parameters: parameters)
end

#template ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/helm-wrapper/shared/runner.rb', line 130

def template()
  logger.fatal("Cannot Helm template without a valid configuration!") if @config.nil?
  logger.fatal("Cannot Helm template before initialising repositories!") unless repos

  parameters = Array.new
  parameters.append("--namespace=\"#{@config.namespace}\"")
  parameters.append("\"#{@config.release}\"")
  parameters.append("\"#{@chart.name}\"")
  parameters.append("--version=\"#{@chart.version}\"") unless @chart.version.strip.empty?
  parameters.concat(variable_files)
  parameters.concat(variable_strings)

  logger.fatal("Helm template failed!") unless run(action: "template", parameters: parameters)
end

#upgrade(install: true) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/helm-wrapper/shared/runner.rb', line 147

def upgrade(install: true)
  logger.fatal("Cannot Helm upgrade without a valid configuration!") if @config.nil?
  logger.fatal("Cannot Helm upgrade before initialising authenticators!") unless auths
  logger.fatal("Cannot Helm upgrade before initialising repositories!") unless repos

  parameters = Array.new
  parameters.append("--namespace=\"#{@config.namespace}\"")
  parameters.append("--install") if install
  parameters.append("\"#{@config.release}\"")
  parameters.append("\"#{@chart.name}\"")
  parameters.append("--atomic") if @config.atomic
  parameters.append("--wait") if @config.wait
  parameters.append("--timeout=\"#{@config.timeout}\"") if (@config.atomic or @config.wait)
  parameters.append("--version=\"#{@chart.version}\"") unless @chart.version.strip.empty?
  parameters.concat(variable_files)
  parameters.concat(variable_strings)

  logger.fatal("Helm upgrade failed!") unless run(action: "upgrade", parameters: parameters)
end