services/api/app/models/container_request.rb

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: AGPL-3.0
   4
   5 require 'whitelist_update'
   6 require 'arvados/collection'
   7
   8 class ContainerRequest < ArvadosModel
   9   include ArvadosModelUpdates
  10   include HasUuid
  11   include KindAndEtag
  12   include CommonApiTemplate
  13   include WhitelistUpdate
  14
  15   belongs_to :container, foreign_key: :container_uuid, primary_key: :uuid
  16   belongs_to :requesting_container, {
  17                class_name: 'Container',
  18                foreign_key: :requesting_container_uuid,
  19                primary_key: :uuid,
  20              }
  21
  22   # Posgresql JSONB columns should NOT be declared as serialized, Rails 5
  23   # already know how to properly treat them.
  24   attribute :properties, :jsonbHash, default: {}
  25   attribute :secret_mounts, :jsonbHash, default: {}
  26
  27   serialize :environment, Hash
  28   serialize :mounts, Hash
  29   serialize :runtime_constraints, Hash
  30   serialize :command, Array
  31   serialize :scheduling_parameters, Hash
  32
  33   before_validation :fill_field_defaults, :if => :new_record?
  34   before_validation :validate_runtime_constraints
  35   before_validation :set_default_preemptible_scheduling_parameter
  36   before_validation :set_container
  37   validates :command, :container_image, :output_path, :cwd, :presence => true
  38   validates :output_ttl, numericality: { only_integer: true, greater_than_or_equal_to: 0 }
  39   validates :priority, numericality: { only_integer: true, greater_than_or_equal_to: 0, less_than_or_equal_to: 1000 }
  40   validate :validate_datatypes
  41   validate :validate_scheduling_parameters
  42   validate :validate_state_change
  43   validate :check_update_whitelist
  44   validate :secret_mounts_key_conflict
  45   validate :validate_runtime_token
  46   before_save :scrub_secrets
  47   before_create :set_requesting_container_uuid
  48   before_destroy :set_priority_zero
  49   after_save :update_priority
  50   after_save :finalize_if_needed
  51
  52   api_accessible :user, extend: :common do |t|
  53     t.add :command
  54     t.add :container_count
  55     t.add :container_count_max
  56     t.add :container_image
  57     t.add :container_uuid
  58     t.add :cwd
  59     t.add :description
  60     t.add :environment
  61     t.add :expires_at
  62     t.add :filters
  63     t.add :log_uuid
  64     t.add :mounts
  65     t.add :name
  66     t.add :output_name
  67     t.add :output_path
  68     t.add :output_uuid
  69     t.add :output_ttl
  70     t.add :priority
  71     t.add :properties
  72     t.add :requesting_container_uuid
  73     t.add :runtime_constraints
  74     t.add :scheduling_parameters
  75     t.add :state
  76     t.add :use_existing
  77   end
  78
  79   def self._index_requires_parameters
  80     (super rescue {}).
  81       merge({
  82         include_trash: {
  83           type: 'boolean', required: false, description: "Include container requests whose owner project is trashed."
  84         },
  85       })
  86   end
  87
  88   def self._show_requires_parameters
  89     (super rescue {}).
  90       merge({
  91         include_trash: {
  92           type: 'boolean', required: false, description: "Show container request even if its owner project is trashed."
  93         },
  94       })
  95   end
  96
  97   # Supported states for a container request
  98   States =
  99     [
 100      (Uncommitted = 'Uncommitted'),
 101      (Committed = 'Committed'),
 102      (Final = 'Final'),
 103     ]
 104
 105   State_transitions = {
 106     nil => [Uncommitted, Committed],
 107     Uncommitted => [Committed],
 108     Committed => [Final]
 109   }
 110
 111   AttrsPermittedAlways = [:owner_uuid, :state, :name, :description, :properties]
 112   AttrsPermittedBeforeCommit = [:command, :container_count_max,
 113   :container_image, :cwd, :environment, :filters, :mounts,
 114   :output_path, :priority, :runtime_token,
 115   :runtime_constraints, :state, :container_uuid, :use_existing,
 116   :scheduling_parameters, :secret_mounts, :output_name, :output_ttl]
 117
 118   def self.limit_index_columns_read
 119     ["mounts"]
 120   end
 121
 122   def logged_attributes
 123     super.except('secret_mounts', 'runtime_token')
 124   end
 125
 126   def state_transitions
 127     State_transitions
 128   end
 129
 130   def skip_uuid_read_permission_check
 131     # The uuid_read_permission_check prevents users from making
 132     # references to objects they can't view.  However, in this case we
 133     # don't want to do that check since there's a circular dependency
 134     # where user can't view the container until the user has
 135     # constructed the container request that references the container.
 136     %w(container_uuid)
 137   end
 138
 139   def finalize_if_needed
 140     return if state != Committed
 141     while true
 142       # get container lock first, then lock current container request
 143       # (same order as Container#handle_completed). Locking always
 144       # reloads the Container and ContainerRequest records.
 145       c = Container.find_by_uuid(container_uuid)
 146       c.lock!
 147       self.lock!
 148
 149       if container_uuid != c.uuid
 150         # After locking, we've noticed a race, the container_uuid is
 151         # different than the container record we just loaded.  This
 152         # can happen if Container#handle_completed scheduled a new
 153         # container for retry and set container_uuid while we were
 154         # waiting on the container lock.  Restart the loop and get the
 155         # new container.
 156         redo
 157       end
 158
 159       if state == Committed && c.final?
 160         # The current container is
 161         act_as_system_user do
 162           leave_modified_by_user_alone do
 163             finalize!
 164           end
 165         end
 166       end
 167       return true
 168     end
 169   end
 170
 171   # Finalize the container request after the container has
 172   # finished/cancelled.
 173   def finalize!
 174     update_collections(container: Container.find_by_uuid(container_uuid))
 175     update_attributes!(state: Final)
 176   end
 177
 178   def update_collections(container:, collections: ['log', 'output'])
 179     collections.each do |out_type|
 180       pdh = container.send(out_type)
 181       next if pdh.nil?
 182       coll_name = "Container #{out_type} for request #{uuid}"
 183       trash_at = nil
 184       if out_type == 'output'
 185         if self.output_name
 186           coll_name = self.output_name
 187         end
 188         if self.output_ttl > 0
 189           trash_at = db_current_time + self.output_ttl
 190         end
 191       end
 192       manifest = Collection.where(portable_data_hash: pdh).first.manifest_text
 193
 194       coll_uuid = self.send(out_type + '_uuid')
 195       coll = coll_uuid.nil? ? nil : Collection.where(uuid: coll_uuid).first
 196       if !coll
 197         coll = Collection.new(
 198           owner_uuid: self.owner_uuid,
 199           name: coll_name,
 200           manifest_text: "",
 201           properties: {
 202             'type' => out_type,
 203             'container_request' => uuid,
 204           })
 205       end
 206
 207       if out_type == "log"
 208         src = Arv::Collection.new(manifest)
 209         dst = Arv::Collection.new(coll.manifest_text)
 210         dst.cp_r("./", ".", src)
 211         dst.cp_r("./", "log for container #{container.uuid}", src)
 212         manifest = dst.manifest_text
 213       end
 214
 215       coll.assign_attributes(
 216         portable_data_hash: Digest::MD5.hexdigest(manifest) + '+' + manifest.bytesize.to_s,
 217         manifest_text: manifest,
 218         trash_at: trash_at,
 219         delete_at: trash_at)
 220       coll.save_with_unique_name!
 221       self.send(out_type + '_uuid=', coll.uuid)
 222     end
 223   end
 224
 225   def self.full_text_searchable_columns
 226     super - ["mounts", "secret_mounts", "secret_mounts_md5", "runtime_token"]
 227   end
 228
 229   protected
 230
 231   def fill_field_defaults
 232     self.state ||= Uncommitted
 233     self.environment ||= {}
 234     self.runtime_constraints ||= {}
 235     self.mounts ||= {}
 236     self.secret_mounts ||= {}
 237     self.cwd ||= "."
 238     self.container_count_max ||= Rails.configuration.Containers.MaxRetryAttempts
 239     self.scheduling_parameters ||= {}
 240     self.output_ttl ||= 0
 241     self.priority ||= 0
 242   end
 243
 244   def set_container
 245     if (container_uuid_changed? and
 246         not current_user.andand.is_admin and
 247         not container_uuid.nil?)
 248       errors.add :container_uuid, "can only be updated to nil."
 249       return false
 250     end
 251     if state_changed? and state == Committed and container_uuid.nil?
 252       while true
 253         c = Container.resolve(self)
 254         c.lock!
 255         if c.state == Container::Cancelled
 256           # Lost a race, we have a lock on the container but the
 257           # container was cancelled in a different request, restart
 258           # the loop and resolve request to a new container.
 259           redo
 260         end
 261         self.container_uuid = c.uuid
 262         break
 263       end
 264     end
 265     if self.container_uuid != self.container_uuid_was
 266       if self.container_count_changed?
 267         errors.add :container_count, "cannot be updated directly."
 268         return false
 269       else
 270         self.container_count += 1
 271         if self.container_uuid_was
 272           old_container = Container.find_by_uuid(self.container_uuid_was)
 273           old_logs = Collection.where(portable_data_hash: old_container.log).first
 274           if old_logs
 275             log_coll = self.log_uuid.nil? ? nil : Collection.where(uuid: self.log_uuid).first
 276             if self.log_uuid.nil?
 277               log_coll = Collection.new(
 278                 owner_uuid: self.owner_uuid,
 279                 name: coll_name = "Container log for request #{uuid}",
 280                 manifest_text: "")
 281             end
 282
 283             # copy logs from old container into CR's log collection
 284             src = Arv::Collection.new(old_logs.manifest_text)
 285             dst = Arv::Collection.new(log_coll.manifest_text)
 286             dst.cp_r("./", "log for container #{old_container.uuid}", src)
 287             manifest = dst.manifest_text
 288
 289             log_coll.assign_attributes(
 290               portable_data_hash: Digest::MD5.hexdigest(manifest) + '+' + manifest.bytesize.to_s,
 291               manifest_text: manifest)
 292             log_coll.save_with_unique_name!
 293             self.log_uuid = log_coll.uuid
 294           end
 295         end
 296       end
 297     end
 298   end
 299
 300   def set_default_preemptible_scheduling_parameter
 301     c = get_requesting_container()
 302     if self.state == Committed
 303       # If preemptible instances (eg: AWS Spot Instances) are allowed,
 304       # ask them on child containers by default.
 305       if Rails.configuration.Containers.UsePreemptibleInstances and !c.nil? and
 306         self.scheduling_parameters['preemptible'].nil?
 307           self.scheduling_parameters['preemptible'] = true
 308       end
 309     end
 310   end
 311
 312   def validate_runtime_constraints
 313     case self.state
 314     when Committed
 315       [['vcpus', true],
 316        ['ram', true],
 317        ['keep_cache_ram', false]].each do |k, required|
 318         if !required && !runtime_constraints.include?(k)
 319           next
 320         end
 321         v = runtime_constraints[k]
 322         unless (v.is_a?(Integer) && v > 0)
 323           errors.add(:runtime_constraints,
 324                      "[#{k}]=#{v.inspect} must be a positive integer")
 325         end
 326       end
 327     end
 328   end
 329
 330   def validate_datatypes
 331     command.each do |c|
 332       if !c.is_a? String
 333         errors.add(:command, "must be an array of strings but has entry #{c.class}")
 334       end
 335     end
 336     environment.each do |k,v|
 337       if !k.is_a?(String) || !v.is_a?(String)
 338         errors.add(:environment, "must be an map of String to String but has entry #{k.class} to #{v.class}")
 339       end
 340     end
 341     [:mounts, :secret_mounts].each do |m|
 342       self[m].each do |k, v|
 343         if !k.is_a?(String) || !v.is_a?(Hash)
 344           errors.add(m, "must be an map of String to Hash but is has entry #{k.class} to #{v.class}")
 345         end
 346         if v["kind"].nil?
 347           errors.add(m, "each item must have a 'kind' field")
 348         end
 349         [[String, ["kind", "portable_data_hash", "uuid", "device_type",
 350                    "path", "commit", "repository_name", "git_url"]],
 351          [Integer, ["capacity"]]].each do |t, fields|
 352           fields.each do |f|
 353             if !v[f].nil? && !v[f].is_a?(t)
 354               errors.add(m, "#{k}: #{f} must be a #{t} but is #{v[f].class}")
 355             end
 356           end
 357         end
 358         ["writable", "exclude_from_output"].each do |f|
 359           if !v[f].nil? && !v[f].is_a?(TrueClass) && !v[f].is_a?(FalseClass)
 360             errors.add(m, "#{k}: #{f} must be a #{t} but is #{v[f].class}")
 361           end
 362         end
 363       end
 364     end
 365   end
 366
 367   def validate_scheduling_parameters
 368     if self.state == Committed
 369       if scheduling_parameters.include? 'partitions' and
 370          (!scheduling_parameters['partitions'].is_a?(Array) ||
 371           scheduling_parameters['partitions'].reject{|x| !x.is_a?(String)}.size !=
 372             scheduling_parameters['partitions'].size)
 373             errors.add :scheduling_parameters, "partitions must be an array of strings"
 374       end
 375       if !Rails.configuration.Containers.UsePreemptibleInstances and scheduling_parameters['preemptible']
 376         errors.add :scheduling_parameters, "preemptible instances are not allowed"
 377       end
 378       if scheduling_parameters.include? 'max_run_time' and
 379         (!scheduling_parameters['max_run_time'].is_a?(Integer) ||
 380           scheduling_parameters['max_run_time'] < 0)
 381           errors.add :scheduling_parameters, "max_run_time must be positive integer"
 382       end
 383     end
 384   end
 385
 386   def check_update_whitelist
 387     permitted = AttrsPermittedAlways.dup
 388
 389     if self.new_record? || self.state_was == Uncommitted
 390       # Allow create-and-commit in a single operation.
 391       permitted.push(*AttrsPermittedBeforeCommit)
 392     end
 393
 394     case self.state
 395     when Committed
 396       permitted.push :priority, :container_count_max, :container_uuid
 397
 398       if self.container_uuid.nil?
 399         self.errors.add :container_uuid, "has not been resolved to a container."
 400       end
 401
 402       if self.priority.nil?
 403         self.errors.add :priority, "cannot be nil"
 404       end
 405
 406       # Allow container count to increment by 1
 407       if (self.container_uuid &&
 408           self.container_uuid != self.container_uuid_was &&
 409           self.container_count == 1 + (self.container_count_was || 0))
 410         permitted.push :container_count
 411       end
 412
 413       if current_user.andand.is_admin
 414         permitted.push :log_uuid
 415       end
 416
 417     when Final
 418       if self.state_was == Committed
 419         # "Cancel" means setting priority=0, state=Committed
 420         permitted.push :priority
 421
 422         if current_user.andand.is_admin
 423           permitted.push :output_uuid, :log_uuid
 424         end
 425       end
 426
 427     end
 428
 429     super(permitted)
 430   end
 431
 432   def secret_mounts_key_conflict
 433     secret_mounts.each do |k, v|
 434       if mounts.has_key?(k)
 435         errors.add(:secret_mounts, 'conflict with non-secret mounts')
 436         return false
 437       end
 438     end
 439   end
 440
 441   def validate_runtime_token
 442     if !self.runtime_token.nil? && self.runtime_token_changed?
 443       if !runtime_token[0..2] == "v2/"
 444         errors.add :runtime_token, "not a v2 token"
 445         return
 446       end
 447       if ApiClientAuthorization.validate(token: runtime_token).nil?
 448         errors.add :runtime_token, "failed validation"
 449       end
 450     end
 451   end
 452
 453   def scrub_secrets
 454     if self.state == Final
 455       self.secret_mounts = {}
 456       self.runtime_token = nil
 457     end
 458   end
 459
 460   def update_priority
 461     return unless state_changed? || priority_changed? || container_uuid_changed?
 462     act_as_system_user do
 463       Container.
 464         where('uuid in (?)', [self.container_uuid_was, self.container_uuid].compact).
 465         map(&:update_priority!)
 466     end
 467   end
 468
 469   def set_priority_zero
 470     self.update_attributes!(priority: 0) if self.state != Final
 471   end
 472
 473   def set_requesting_container_uuid
 474     c = get_requesting_container()
 475     if !c.nil?
 476       self.requesting_container_uuid = c.uuid
 477       # Determine the priority of container request for the requesting
 478       # container.
 479       self.priority = ContainerRequest.where(container_uuid: self.requesting_container_uuid).maximum("priority") || 0
 480     end
 481   end
 482
 483   def get_requesting_container
 484     return self.requesting_container_uuid if !self.requesting_container_uuid.nil?
 485     Container.for_current_token
 486   end
 487 end