Class: OpenC3::MicroserviceModel

Inherits:
Model show all
Defined in:
lib/openc3/models/microservice_model.rb

Constant Summary collapse

PRIMARY_KEY = 
'openc3_microservices'

Instance Attribute Summary collapse

Attributes inherited from Model

#name, #plugin, #scope, #updated_at

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Model

#create, #destroy, #destroyed?, filter, find_all_by_plugin, from_json, get_all_models, get_model, set, store, #update

Constructor Details

#initialize(name:, folder_name: nil, cmd: [], work_dir: '.', ports: [], env: {}, topics: [], target_names: [], options: [], parent: nil, container: nil, updated_at: nil, plugin: nil, needs_dependencies: false, secrets: [], scope:) ⇒ MicroserviceModel

Create a microservice model to be deployed to bucket storage



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/openc3/models/microservice_model.rb', line 85

def initialize(
  name:,
  folder_name: nil,
  cmd: [],
  work_dir: '.',
  ports: [],
  env: {},
  topics: [],
  target_names: [],
  options: [],
  parent: nil,
  container: nil,
  updated_at: nil,
  plugin: nil,
  needs_dependencies: false,
  secrets: [],
  scope:
)
  parts = name.split("__")
  if parts.length != 3
    raise "name '#{name}' must be formatted as SCOPE__TYPE__NAME"
  end
  if parts[0] != scope
    raise "name '#{name}' scope '#{parts[0]}' doesn't match scope parameter '#{scope}'"
  end

  super(PRIMARY_KEY, name: name, updated_at: updated_at, plugin: plugin, scope: scope)
  @folder_name = folder_name
  @cmd = cmd
  @work_dir = work_dir
  @ports = ports
  @env = env
  @topics = topics
  @target_names = target_names
  @options = options
  @parent = parent
  @container = container
  @needs_dependencies = needs_dependencies
  @secrets = secrets
  @bucket = Bucket.getClient()
end

Instance Attribute Details

#cmd ⇒ Object

Returns the value of attribute cmd.



31
32
33
 
# File 'lib/openc3/models/microservice_model.rb', line 31

def cmd
  @cmd
end

#container ⇒ Object

Returns the value of attribute container.



32
33
34
 
# File 'lib/openc3/models/microservice_model.rb', line 32

def container
  @container
end

#env ⇒ Object

Returns the value of attribute env.



33
34
35
 
# File 'lib/openc3/models/microservice_model.rb', line 33

def env
  @env
end

#folder_name ⇒ Object

Returns the value of attribute folder_name.



34
35
36
 
# File 'lib/openc3/models/microservice_model.rb', line 34

def folder_name
  @folder_name
end

#needs_dependencies ⇒ Object

Returns the value of attribute needs_dependencies.



35
36
37
 
# File 'lib/openc3/models/microservice_model.rb', line 35

def needs_dependencies
  @needs_dependencies
end

#options ⇒ Object

Returns the value of attribute options.



36
37
38
 
# File 'lib/openc3/models/microservice_model.rb', line 36

def options
  @options
end

#parent ⇒ Object

Returns the value of attribute parent.



41
42
43
 
# File 'lib/openc3/models/microservice_model.rb', line 41

def parent
  @parent
end

#ports ⇒ Object

Returns the value of attribute ports.



40
41
42
 
# File 'lib/openc3/models/microservice_model.rb', line 40

def ports
  @ports
end

#secrets ⇒ Object

Returns the value of attribute secrets.



42
43
44
 
# File 'lib/openc3/models/microservice_model.rb', line 42

def secrets
  @secrets
end

#target_names ⇒ Object

Returns the value of attribute target_names.



37
38
39
 
# File 'lib/openc3/models/microservice_model.rb', line 37

def target_names
  @target_names
end

#topics ⇒ Object

Returns the value of attribute topics.



38
39
40
 
# File 'lib/openc3/models/microservice_model.rb', line 38

def topics
  @topics
end

#work_dir ⇒ Object

Returns the value of attribute work_dir.



39
40
41
 
# File 'lib/openc3/models/microservice_model.rb', line 39

def work_dir
  @work_dir
end

Class Method Details

.all(scope: nil) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/openc3/models/microservice_model.rb', line 61

def self.all(scope: nil)
  scoped = {}
  unscoped = super(PRIMARY_KEY)
  unscoped.each do |name, json|
    if !scope or name.split("__")[0] == scope
      scoped[name] = json
    end
  end
  scoped
end

.get(name:, scope: nil) ⇒ Object

NOTE: The following three class methods are used by the ModelController and are reimplemented to enable various Model class methods to work



46
47
48
 
# File 'lib/openc3/models/microservice_model.rb', line 46

def self.get(name:, scope: nil)
  super(PRIMARY_KEY, name: name)
end

.handle_config(parser, keyword, parameters, plugin: nil, needs_dependencies: false, scope:) ⇒ Object

Called by the PluginModel to allow this class to validate it’s top-level keyword: “MICROSERVICE”



73
74
75
76
77
78
79
80
81
82
 
# File 'lib/openc3/models/microservice_model.rb', line 73

def self.handle_config(parser, keyword, parameters, plugin: nil, needs_dependencies: false, scope:)
  case keyword
  when 'MICROSERVICE'
    parser.verify_num_parameters(2, 2, "#{keyword} <Folder Name> <Name>")
    # Create name by adding scope and type 'USER' to indicate where this microservice came from
    return self.new(folder_name: parameters[0], name: "#{scope}__USER__#{parameters[1].upcase}", plugin: plugin, needs_dependencies: needs_dependencies, scope: scope)
  else
    raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Microservice: #{keyword} #{parameters.join(" ")}")
  end
end

.names(scope: nil) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/openc3/models/microservice_model.rb', line 50

def self.names(scope: nil)
  scoped = []
  unscoped = super(PRIMARY_KEY)
  unscoped.each do |name|
    if !scope or name.split("__")[0] == scope
      scoped << name
    end
  end
  scoped
end

Instance Method Details

#as_json(*a) ⇒ Object 



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/openc3/models/microservice_model.rb', line 127

def as_json(*a)
  {
    'name' => @name,
    'folder_name' => @folder_name,
    'cmd' => @cmd,
    'work_dir' => @work_dir,
    'ports' => @ports,
    'env' => @env,
    'topics' => @topics,
    'target_names' => @target_names,
    'options' => @options,
    'parent' => @parent,
    'container' => @container,
    'updated_at' => @updated_at,
    'plugin' => @plugin,
    'needs_dependencies' => @needs_dependencies,
    'secrets' => @secrets.as_json(*a)
  }
end

#deploy(gem_path, variables, validate_only: false) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/openc3/models/microservice_model.rb', line 198

def deploy(gem_path, variables, validate_only: false)
  return unless @folder_name

  variables["microservice_name"] = @name
  start_path = "/microservices/#{@folder_name}/"
  Dir.glob(gem_path + start_path + "**/*") do |filename|
    next if filename == '.' or filename == '..' or File.directory?(filename)

    path = filename.split(gem_path)[-1]
    key = "#{@scope}/microservices/#{@name}/" + path.split(start_path)[-1]

    # Load microservice files
    data = File.read(filename, mode: "rb")
    OpenC3.set_working_dir(File.dirname(filename)) do
      data = ERB.new(data, trim_mode: "-").result(binding.set_variables(variables)) if data.is_printable?
    end
    unless validate_only
      @bucket.put_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: key, body: data)
      ConfigTopic.write({ kind: 'created', type: 'microservice', name: @name, plugin: @plugin }, scope: @scope)
    end
  end
end

#handle_config(parser, keyword, parameters) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/openc3/models/microservice_model.rb', line 147

def handle_config(parser, keyword, parameters)
  case keyword
  when 'ENV'
    parser.verify_num_parameters(2, 2, "#{keyword} <Key> <Value>")
    @env[parameters[0]] = parameters[1]
  when 'WORK_DIR'
    parser.verify_num_parameters(1, 1, "#{keyword} <Dir>")
    @work_dir = parameters[0]
  when 'PORT'
    usage = "PORT <Number> <Protocol (Optional)"
    parser.verify_num_parameters(1, 2, usage)
    begin
      @ports << [Integer(parameters[0])]
    rescue => err # In case Integer fails
      raise ConfigParser::Error.new(parser, "Port must be an integer: #{parameters[0]}", usage)
    end
    protocol = ConfigParser.handle_nil(parameters[1])
    if protocol
      # Per https://kubernetes.io/docs/concepts/services-networking/service/#protocol-support
      if %w(TCP UDP SCTP HTTP SCTP).include?(protocol.upcase)
        @ports[-1] << protocol.upcase
      else
        raise ConfigParser::Error.new(parser, "Unknown port protocol: #{parameters[1]}", usage)
      end
    else
      @ports[-1] << 'TCP'
    end
  when 'TOPIC'
    parser.verify_num_parameters(1, 1, "#{keyword} <Topic Name>")
    @topics << parameters[0]
  when 'TARGET_NAME'
    parser.verify_num_parameters(1, 1, "#{keyword} <Target Name>")
    @target_names << parameters[0]
  when 'CMD'
    parser.verify_num_parameters(1, nil, "#{keyword} <Args>")
    @cmd = parameters.dup
  when 'OPTION'
    parser.verify_num_parameters(2, nil, "#{keyword} <Option Name> <Option Values>")
    @options << parameters.dup
  when 'CONTAINER'
    parser.verify_num_parameters(1, 1, "#{keyword} <Container Image Name>")
    @container = parameters[0]
  when 'SECRET'
    parser.verify_num_parameters(3, 3, "#{keyword} <Secret Type: ENV or FILE> <Secret Name> <Environment Variable Name or File Path>")
    @secrets << parameters.dup
  else
    raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Microservice: #{keyword} #{parameters.join(" ")}")
  end
  return nil
end

#undeploy ⇒ Object 



221
222
223
224
225
226
227
228
229
 
# File 'lib/openc3/models/microservice_model.rb', line 221

def undeploy
  prefix = "#{@scope}/microservices/#{@name}/"
  @bucket.list_objects(bucket: ENV['OPENC3_CONFIG_BUCKET'], prefix: prefix).each do |object|
    @bucket.delete_object(bucket: ENV['OPENC3_CONFIG_BUCKET'], key: object.key)
  end
  ConfigTopic.write({ kind: 'deleted', type: 'microservice', name: @name, plugin: @plugin }, scope: @scope)
rescue Exception => error
  Logger.error("Error undeploying microservice model #{@name} in scope #{@scope} due to #{error}")
end