openc3 5.19.0 → 6.0.0

data/lib/openc3/interfaces/udp_interface.rb

@@ -27,6 +27,8 @@ require 'openc3/config/config_parser'
 module OpenC3
   # Base class for interfaces that send and receive messages over UDP
   class UdpInterface < Interface
+    HOST_127_0_0_1 = '127.0.0.1'
+
     # @param hostname [String] Machine to connect to
     # @param write_dest_port [Integer] Port to write commands to
     # @param read_port [Integer] Port to read telemetry from
@@ -56,7 +58,7 @@ module OpenC3
       @hostname = ConfigParser.handle_nil(hostname)
       if @hostname
         @hostname = @hostname.to_s
-        @hostname = '127.0.0.1' if @hostname.casecmp('LOCALHOST').zero?
+        @hostname = HOST_127_0_0_1 if @hostname.casecmp('LOCALHOST').zero?
       end
       @write_dest_port = ConfigParser.handle_nil(write_dest_port)
       @write_dest_port = write_dest_port.to_i if @write_dest_port
@@ -66,7 +68,7 @@ module OpenC3
       @write_src_port = @write_src_port.to_i if @write_src_port
       @interface_address = ConfigParser.handle_nil(interface_address)
       if @interface_address && @interface_address.casecmp('LOCALHOST').zero?
-        @interface_address = '127.0.0.1'
+        @interface_address = HOST_127_0_0_1
       end
       @ttl = ttl.to_i
       @ttl = 1 if @ttl < 1
@@ -81,7 +83,7 @@ module OpenC3
       @read_timeout = @read_timeout.to_f if @read_timeout
       @bind_address = ConfigParser.handle_nil(bind_address)
       if @bind_address && @bind_address.casecmp('LOCALHOST').zero?
-        @bind_address = '127.0.0.1'
+        @bind_address = HOST_127_0_0_1
       end
       @write_socket = nil
       @read_socket = nil

data/lib/openc3/interfaces.rb

@@ -14,7 +14,7 @@
 # GNU Affero General Public License for more details.
 
 # Modified by OpenC3, Inc.
-# All changes Copyright 2022, OpenC3, Inc.
+# All changes Copyright 2024, OpenC3, Inc.
 # All Rights Reserved
 #
 # This file may also be used under the terms of a commercial license
@@ -25,15 +25,13 @@ module OpenC3
   autoload(:HttpClientInterface, 'openc3/interfaces/http_client_interface.rb')
   autoload(:HttpServerInterface, 'openc3/interfaces/http_server_interface.rb')
   autoload(:MqttInterface, 'openc3/interfaces/mqtt_interface.rb')
+  autoload(:MqttStreamInterface, 'openc3/interfaces/mqtt_stream_interface.rb')
   autoload(:StreamInterface, 'openc3/interfaces/stream_interface.rb')
   autoload(:SerialInterface, 'openc3/interfaces/serial_interface.rb')
   autoload(:SimulatedTargetInterface, 'openc3/interfaces/simulated_target_interface.rb')
   autoload(:TcpipClientInterface, 'openc3/interfaces/tcpip_client_interface.rb')
   autoload(:TcpipServerInterface, 'openc3/interfaces/tcpip_server_interface.rb')
   autoload(:UdpInterface, 'openc3/interfaces/udp_interface.rb')
-  autoload(:LincInterface, 'openc3/interfaces/linc_interface.rb')
-  autoload(:LincHandshakeCommand, 'openc3/interfaces/linc_interface.rb')
-  autoload(:LincHandshake, 'openc3/interfaces/linc_interface.rb')
 
   autoload(:Protocol, 'openc3/interfaces/protocols/protocol.rb')
   autoload(:BurstProtocol, 'openc3/interfaces/protocols/burst_protocol.rb')

data/lib/openc3/io/json_drb.rb

@@ -302,6 +302,11 @@ module OpenC3
                 response = JsonRpcErrorResponse.new(
                   JsonRpcError.new(error_code, e.message, e), request.id
                 )
+              elsif CriticalCmdError === e
+                error_code = JsonRpcError::ErrorCode::CRITICAL_CMD_ERROR
+                response = JsonRpcErrorResponse.new(
+                  JsonRpcError.new(error_code, e.message, e), request.id
+                )
               else
                 error_code = JsonRpcError::ErrorCode::OTHER_ERROR
                 response = JsonRpcErrorResponse.new(

data/lib/openc3/io/json_rpc.rb

@@ -379,16 +379,17 @@ module OpenC3
   class JsonRpcError < JsonRpc
     # Enumeration of JSON RPC error codes
     class ErrorCode
-      PARSE_ERROR      = -32700
-      INVALID_REQUEST  = -32600
-      METHOD_NOT_FOUND = -32601
-      INVALID_PARAMS   = -32602
-      INTERNAL_ERROR   = -32603
-      AUTH_ERROR       = -32500
-      FORBIDDEN_ERROR  = -32501
-      HAZARDOUS_ERROR  = -32502
+      PARSE_ERROR        = -32700
+      INVALID_REQUEST    = -32600
+      METHOD_NOT_FOUND   = -32601
+      INVALID_PARAMS     = -32602
+      INTERNAL_ERROR     = -32603
+      AUTH_ERROR         = -32500
+      FORBIDDEN_ERROR    = -32501
+      HAZARDOUS_ERROR    = -32502
+      CRITICAL_CMD_ERROR = -32503
       # Server error reserved: -32000 to -32099
-      OTHER_ERROR      = -1
+      OTHER_ERROR        = -1
     end
 
     # @param code [Integer] The error type that occurred

data/lib/openc3/io/udp_sockets.rb

@@ -17,7 +17,7 @@
 # All changes Copyright 2022, OpenC3, Inc.
 # All Rights Reserved
 #
-# This file may also be used under the terms of a commercial license 
+# This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
 require 'socket'
@@ -30,6 +30,8 @@ Socket::IP_MULTICAST_TTL = 10 unless Socket.const_defined?('IP_MULTICAST_TTL')
 
 module OpenC3
   class UdpReadWriteSocket
+    HOST_0_0_0_0 = '0.0.0.0'
+
     # @param bind_port [Integer[ Port to write data out from and receive data on (0 = randomly assigned)
     # @param bind_address [String] Local address to bind to (0.0.0.0 = All local addresses)
     # @param external_port [Integer] External port to write to
@@ -40,7 +42,7 @@ module OpenC3
     # @param write_multicast [Boolean] Whether or not to write to the external address as multicast
     def initialize(
       bind_port = 0,
-      bind_address = "0.0.0.0",
+      bind_address = HOST_0_0_0_0,
       external_port = nil,
       external_address = nil,
       multicast_interface_address = nil,
@@ -76,7 +78,7 @@ module OpenC3
 
         # Receive messages sent to the multicast address
         if read_multicast
-          multicast_interface_address = "0.0.0.0" unless multicast_interface_address
+          multicast_interface_address = HOST_0_0_0_0 unless multicast_interface_address
           membership = IPAddr.new(external_address).hton + IPAddr.new(multicast_interface_address).hton
           @socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, membership)
         end
@@ -155,7 +157,7 @@ module OpenC3
       src_port = nil,
       multicast_interface_address = nil,
       ttl = 1,
-      bind_address = "0.0.0.0"
+      bind_address = HOST_0_0_0_0
     )
 
       super(
@@ -180,7 +182,7 @@ module OpenC3
       recv_port = 0,
       multicast_address = nil,
       multicast_interface_address = nil,
-      bind_address = "0.0.0.0"
+      bind_address = HOST_0_0_0_0
     )
 
       super(

data/lib/openc3/microservices/decom_microservice.rb

@@ -20,6 +20,7 @@
 # This file may also be used under the terms of a commercial license
 # if purchased from OpenC3, Inc.
 
+require 'time'
 require 'openc3/microservices/microservice'
 require 'openc3/microservices/interface_decom_common'
 require 'openc3/topics/telemetry_decom_topic'
@@ -28,6 +29,7 @@ require 'openc3/topics/limits_event_topic'
 module OpenC3
   class DecomMicroservice < Microservice
     include InterfaceDecomCommon
+    LIMITS_STATE_INDEX = { RED_LOW: 0, YELLOW_LOW: 1, YELLOW_HIGH: 2, RED_HIGH: 3, GREEN_LOW: 4, GREEN_HIGH: 5 }
 
     def initialize(*args)
       super(*args)
@@ -134,31 +136,46 @@ module OpenC3
     # @param log_change [Boolean] Whether to log this limits change event
     def limits_change_callback(packet, item, old_limits_state, value, log_change)
       return if @cancel_thread
-      packet_time = packet.packet_time
+      # Make a copy because packet_time is frozen
+      packet_time = packet.packet_time.dup
       if value
         message = "#{packet.target_name} #{packet.packet_name} #{item.name} = #{value} is #{item.limits.state}"
+        if item.limits.values
+          values = item.limits.values[System.limits_set]
+          # Check if the state is RED_LOW, YELLOW_LOW, YELLOW_HIGH, RED_HIGH, GREEN_LOW, GREEN_HIGH
+          if LIMITS_STATE_INDEX[item.limits.state]
+            # Directly index into the values and return the value
+            message += " (#{values[LIMITS_STATE_INDEX[item.limits.state]]})"
+          elsif item.limits.state == :GREEN
+            # If we're green we display the green range (YELLOW_LOW - YELLOW_HIGH)
+            message += " (#{values[1]} to #{values[2]})"
+          elsif item.limits.state == :BLUE
+            # If we're blue we display the blue range (GREEN_LOW - GREEN_HIGH)
+            message += " (#{values[4]} to #{values[5]})"
+          end
+        end
       else
         message = "#{packet.target_name} #{packet.packet_name} #{item.name} is disabled"
       end
-      message << " (#{packet.packet_time.sys.formatted})" if packet_time
 
-      time_nsec = packet_time ? packet_time.to_nsec_from_epoch : Time.now.to_nsec_from_epoch
+      # Include the packet_time in the log json but not the log message
+      time = { packet_time: packet_time.utc.iso8601(6) }
       if log_change
         case item.limits.state
         when :BLUE, :GREEN, :GREEN_LOW, :GREEN_HIGH
           # Only print INFO messages if we're changing ... not on initialization
-          @logger.info message if old_limits_state
+          @logger.info(message, other: time) if old_limits_state
         when :YELLOW, :YELLOW_LOW, :YELLOW_HIGH
-          @logger.warn(message, type: Logger::NOTIFICATION)
+          @logger.warn(message, other: time, type: Logger::NOTIFICATION)
         when :RED, :RED_LOW, :RED_HIGH
-          @logger.error(message, type: Logger::ALERT)
+          @logger.error(message, other: time, type: Logger::ALERT)
         end
       end
 
       # The openc3_limits_events topic can be listened to for all limits events, it is a continuous stream
       event = { type: :LIMITS_CHANGE, target_name: packet.target_name, packet_name: packet.packet_name,
                 item_name: item.name, old_limits_state: old_limits_state.to_s, new_limits_state: item.limits.state.to_s,
-                time_nsec: time_nsec, message: message.to_s }
+                time_nsec: packet_time.to_nsec_from_epoch, message: message.to_s }
       LimitsEventTopic.write(event, scope: @scope)
 
       if item.limits.response

data/lib/openc3/microservices/interface_microservice.rb

@@ -26,6 +26,7 @@ require 'openc3/models/interface_model'
 require 'openc3/models/router_model'
 require 'openc3/models/interface_status_model'
 require 'openc3/models/router_status_model'
+require 'openc3/models/scope_model'
 require 'openc3/topics/telemetry_topic'
 require 'openc3/topics/command_topic'
 require 'openc3/topics/command_decom_topic'
@@ -33,6 +34,12 @@ require 'openc3/topics/interface_topic'
 require 'openc3/topics/router_topic'
 require 'openc3/interfaces/interface'
 
+begin
+  require 'openc3-enterprise/models/critical_cmd_model'
+rescue LoadError
+  # Should never actual be used in Open Source
+end
+
 module OpenC3
   class InterfaceCmdHandlerThread
     include InterfaceDecomCommon
@@ -41,6 +48,12 @@ module OpenC3
       @interface = interface
       @tlm = tlm
       @scope = scope
+      scope_model = ScopeModel.get_model(name: @scope)
+      if scope_model
+        @critical_commanding = scope_model.critical_commanding
+      else
+        @critical_commanding = 'OFF'
+      end
       @logger = logger
       @logger = Logger unless @logger
       @metric = metric
@@ -70,10 +83,21 @@ module OpenC3
     def run
       InterfaceTopic.receive_commands(@interface, scope: @scope) do |topic, msg_id, msg_hash, _redis|
         OpenC3.with_context(msg_hash) do
+          release_critical = false
           msgid_seconds_from_epoch = msg_id.split('-')[0].to_i / 1000.0
           delta = Time.now.to_f - msgid_seconds_from_epoch
           @metric.set(name: 'interface_topic_delta_seconds', value: delta, type: 'gauge', unit: 'seconds', help: 'Delta time between data written to stream and interface cmd start') if @metric
 
+          if topic == "OPENC3__SYSTEM__EVENTS"
+            msg = JSON.parse(msg_hash['event'])
+            if msg['type'] == 'scope'
+              if msg['name'] == @scope
+                @critical_commanding = msg['critical_commanding']
+              end
+            end
+            next 'SUCCESS'
+          end
+
           # Check for a raw write to the interface
           if topic =~ /CMD}INTERFACE/
             @directive_count += 1
@@ -150,10 +174,21 @@ module OpenC3
               handle_inject_tlm(msg_hash['inject_tlm'])
               next 'SUCCESS'
             end
+            if msg_hash.key?('release_critical')
+              # Note: intentional fall through below this point
+              model = CriticalCmdModel.get_model(name: msg_hash['release_critical'], scope: @scope)
+              if model
+                msg_hash = model.cmd_hash
+                release_critical = true
+              else
+                next "Critical command #{msg_hash['release_critical']} not found"
+              end
+            end
           end
 
           target_name = msg_hash['target_name']
           cmd_name = msg_hash['cmd_name']
+          manual = ConfigParser.handle_true_false(msg_hash['manual'])
           cmd_params = nil
           cmd_buffer = nil
           hazardous_check = nil
@@ -195,11 +230,29 @@ module OpenC3
             command.extra ||= {}
             command.extra['cmd_string'] = msg_hash['cmd_string']
             command.extra['username'] = msg_hash['username']
-            if hazardous_check
-              hazardous, hazardous_description = System.commands.cmd_pkt_hazardous?(command)
-              # Return back the error, description, and the formatted command
-              # This allows the error handler to simply re-send the command
-              next "HazardousError\n#{hazardous_description}\n#{msg_hash['cmd_string']}" if hazardous
+            hazardous, hazardous_description = System.commands.cmd_pkt_hazardous?(command)
+
+            # Initial Are you sure? Hazardous check
+            # Return back the error, description, and the formatted command
+            # This allows the error handler to simply re-send the command
+            next "HazardousError\n#{hazardous_description}\n#{msg_hash['cmd_string']}" if hazardous_check and hazardous and not release_critical
+
+            # Check for Critical Command
+            if @critical_commanding and @critical_commanding != 'OFF' and not release_critical
+              restricted = command.restricted
+              if hazardous or restricted or (@critical_commanding == 'ALL' and manual)
+                if hazardous
+                  type = 'HAZARDOUS'
+                elsif restricted
+                  type = 'RESTRICTED'
+                else
+                  type = 'NORMAL'
+                end
+                model = CriticalCmdModel.new(name: SecureRandom.uuid, type: type, interface_name: @interface.name, username: msg_hash['username'], cmd_hash: msg_hash, scope: @scope)
+                model.create
+                @logger.info("Critical Cmd Pending: #{msg_hash['cmd_string']}", user: msg_hash['username'], scope: @scope)
+                next "CriticalCmdError\n#{model.name}"
+              end
             end
 
             validate = ConfigParser.handle_true_false(msg_hash['validate'])
@@ -223,6 +276,12 @@ module OpenC3
 
                 @count += 1
                 @metric.set(name: 'interface_cmd_total', value: @count, type: 'counter') if @metric
+
+                log_message = ConfigParser.handle_true_false(msg_hash['log_message'])
+                if log_message
+                  @logger.info(msg_hash['cmd_string'], user: msg_hash['username'], scope: @scope)
+                end
+
                 @interface.write(command)
 
                 if command.validator and validate
@@ -440,8 +499,7 @@ module OpenC3
 
       @queued = false
       @interface.options.each do |option_name, option_values|
-        case option_name.upcase
-        when 'OPTIMIZE_THROUGHPUT'
+        if option_name.upcase == 'OPTIMIZE_THROUGHPUT'
           @queued = true
           update_interval = option_values[0].to_f
           EphemeralStoreQueued.instance.set_update_interval(update_interval)

data/lib/openc3/microservices/microservice.rb

@@ -222,8 +222,7 @@ module OpenC3
     # Returns if the command was handled
     def microservice_cmd(topic, msg_id, msg_hash, _redis)
       command = msg_hash['command']
-      case command
-      when 'ADD_TOPICS'
+      if command == 'ADD_TOPICS'
         topics = JSON.parse(msg_hash['topics'])
         if topics and Array === topics
           topics.each do |new_topic|

data/lib/openc3/microservices/multi_microservice.rb

@@ -1,6 +1,6 @@
 # encoding: ascii-8bit
 
-# Copyright 2022 OpenC3 Inc.
+# Copyright 2024 OpenC3 Inc.
 # All Rights Reserved.
 #
 # This program is free software; you can modify and/or redistribute it
@@ -36,8 +36,8 @@ module OpenC3
             end
           end
           raise "Could not determine class filename from '#{cmd_line}'" unless filename
-          OpenC3.set_working_dir(@work_dir) do
-            require_relative filename
+          OpenC3.set_working_dir(microservice_model.work_dir) do
+            require File.join(microservice_model.work_dir, filename)
           end
           klass = filename.filename_to_class_name.to_class
           klass.run(microservice_model.name)

data/lib/openc3/migrations/20241208080000_no_critical_cmd.rb

@@ -0,0 +1,31 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/scope_model'
+require 'openc3/models/microservice_model'
+
+module OpenC3
+  class NoCriticalCmd < Migration
+    begin
+      require 'openc3-enterprise/models/cmd_authority_model'
+      require 'openc3-enterprise/models/critical_cmd_model'
+      BASE = false
+    rescue LoadError
+      BASE = true
+    end
+
+    def self.run
+      ScopeModel.get_all_models(scope: nil).each do |scope, scope_model|
+        model = MicroserviceModel.get_model(name: "#{scope}__CRITICALCMD__#{scope}", scope: scope)
+        if BASE # Only remove the critical command model if we're not enterprise
+          model.destroy if model
+        else
+          model.work_dir = '/openc3-enterprise/lib/openc3-enterprise/microservices'
+          model.update
+        end
+      end
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::NoCriticalCmd.run
+end

data/lib/openc3/migrations/20241208080001_no_trigger_group.rb

@@ -0,0 +1,46 @@
+require 'openc3/utilities/migration'
+require 'openc3/models/scope_model'
+require 'openc3/models/microservice_model'
+
+module OpenC3
+  class NoTriggerGroups < Migration
+    begin
+      require 'openc3-enterprise/models/cmd_authority_model'
+      require 'openc3-enterprise/models/critical_cmd_model'
+      BASE = false
+    rescue LoadError
+      BASE = true
+    end
+
+    def self.run
+      MicroserviceModel.get_all_models(scope: 'DEFAULT').each do |microservice_name, microservice_model|
+        if microservice_name =~ /__TRIGGER_GROUP__/
+          if BASE
+            # Only remove the trigger group microservice if we're not enterprise
+            microservice_model.destroy
+          else
+            # Need to update working dir for Enterprise
+            microservice_model.work_dir = '/openc3-enterprise/lib/openc3-enterprise/microservices'
+            microservice_model.update
+          end
+        end
+
+        if microservice_name =~ /__OPENC3__REACTION/
+          # Need to update working dir for Enterprise
+          microservice_model.work_dir = '/openc3-enterprise/lib/openc3-enterprise/microservices'
+          microservice_model.update
+        end
+
+        if microservice_name =~ /__TIMELINE__/
+          # Need to update working dir for Enterprise
+          microservice_model.work_dir = '/openc3-enterprise/lib/openc3-enterprise/microservices'
+          microservice_model.update
+        end
+      end
+    end
+  end
+end
+
+unless ENV['OPENC3_NO_MIGRATE']
+  OpenC3::NoTriggerGroups.run
+end

data/lib/openc3/models/activity_model.rb

@@ -121,7 +121,7 @@ module OpenC3
 
       notification = {
         # start / stop to match SortedModel
-        'data' => JSON.generate({'start' => score}),
+        'data' => JSON.generate({'start' => score, 'uuid' => uuid}),
         'kind' => 'deleted',
         'type' => 'activity',
         'timeline' => name
@@ -361,7 +361,7 @@ module OpenC3
           end
         end
       end
-      notify(kind: 'updated', extra: old_start)
+      notify(kind: 'updated', extra: {old_start: old_start, old_uuid: old_uuid})
       return @start
     end
 
@@ -409,7 +409,11 @@ module OpenC3
         'type' => 'activity',
         'timeline' => @name
       }
-      notification['extra'] = extra unless extra.nil?
+      if extra
+        extra.each do |key, value|
+          notification[key.to_s] = value
+        end
+      end
       begin
         TimelineTopic.write_activity(notification, scope: @scope)
       rescue StandardError => e

data/lib/openc3/models/cvt_model.rb

@@ -156,7 +156,13 @@ module OpenC3
               item_result[1] = item_result[1].intern if item_result[1] # Convert to symbol
             end
           else
-            raise "Item '#{target_name} #{packet_name} #{value_keys[-1]}' does not exist" unless hash.key?(value_keys[-1])
+            # We didn't find a value but the packet hash contains the key so the item exists
+            # Thus set the result to nil so it comes back like a normal item
+            if hash.key?(value_keys[-1])
+              item_result[1] = nil
+            else
+              raise "Item '#{target_name} #{packet_name} #{value_keys[-1]}' does not exist"
+            end
           end
         end
         results << item_result

data/lib/openc3/models/interface_model.rb

@@ -50,6 +50,7 @@ module OpenC3
     attr_accessor :work_dir
     attr_accessor :ports
     attr_accessor :prefix
+    attr_accessor :shard
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -121,6 +122,7 @@ module OpenC3
       env: {},
       container: nil,
       prefix: nil,
+      shard: 0,
       scope:
     )
       if self.class._get_type == 'INTERFACE'
@@ -158,6 +160,7 @@ module OpenC3
       @env = env
       @container = container
       @prefix = prefix
+      @shard = shard.to_i # to_i to handle nil
       @secrets = secrets
     end
 
@@ -222,6 +225,7 @@ module OpenC3
         'env' => @env,
         'container' => @container,
         'prefix' => @prefix,
+        'shard' => @shard,
         'updated_at' => @updated_at
       }
     end
@@ -297,9 +301,7 @@ module OpenC3
           # Option Name, Secret Name
           @secret_options << [parameters[3], parameters[1]]
         end
-        if ConfigParser.handle_nil(parameters[4])
-          @secrets[-1] << parameters[4]
-        end
+        @secrets[-1] << ConfigParser.handle_nil(parameters[4])
 
       when 'ENV'
         parser.verify_num_parameters(2, 2, "#{keyword} <Key> <Value>")
@@ -341,6 +343,9 @@ module OpenC3
         parser.verify_num_parameters(1, 1, "#{keyword} <Route Prefix>")
         @prefix = parameters[0]
 
+      when 'SHARD'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Shard Number Starting from 0>")
+        @shard = Integer(parameters[0])
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Interface/Router: #{keyword} #{parameters.join(" ")}")
 
@@ -365,6 +370,7 @@ module OpenC3
         needs_dependencies: @needs_dependencies,
         secrets: @secrets,
         prefix: @prefix,
+        shard: @shard,
         scope: @scope
       )
       unless validate_only

data/lib/openc3/models/microservice_model.rb

@@ -44,6 +44,7 @@ module OpenC3
     attr_accessor :prefix
     attr_accessor :disable_erb
     attr_accessor :ignore_changes
+    attr_accessor :shard
 
     # NOTE: The following three class methods are used by the ModelController
     # and are reimplemented to enable various Model class methods to work
@@ -105,6 +106,7 @@ module OpenC3
       prefix: nil,
       disable_erb: nil,
       ignore_changes: nil,
+      shard: 0,
       scope:
     )
       parts = name.split("__")
@@ -131,6 +133,7 @@ module OpenC3
       @prefix = prefix
       @disable_erb = disable_erb
       @ignore_changes = ignore_changes
+      @shard = shard.to_i # to_i to handle nil
       @bucket = Bucket.getClient()
     end
 
@@ -153,7 +156,8 @@ module OpenC3
         'secrets' => @secrets.as_json(*a),
         'prefix' => @prefix,
         'disable_erb' => @disable_erb,
-        'ignore_changes' => @ignore_changes
+        'ignore_changes' => @ignore_changes,
+        'shard' => @shard,
       }
     end
 
@@ -215,6 +219,9 @@ module OpenC3
         if parameters
           @disable_erb.concat(parameters)
         end
+      when 'SHARD'
+        parser.verify_num_parameters(1, 1, "#{keyword} <Shard Number Starting from 0>")
+        @shard = Integer(parameters[0])
       else
         raise ConfigParser::Error.new(parser, "Unknown keyword and parameters for Microservice: #{keyword} #{parameters.join(" ")}")
       end

data/lib/openc3/models/model.rb

@@ -172,6 +172,7 @@ module OpenC3
     # Undo the actions of deploy and remove the model from OpenC3.
     # Subclasses must implement this as by default it is a noop.
     def undeploy
+      # empty for a reason
     end
 
     # Delete the model from the Store