sdk/go/arvados/container.go

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: Apache-2.0
   4
   5 package arvados
   6
   7 import "time"
   8
   9 // Container is an arvados#container resource.
  10 type Container struct {
  11         UUID                      string                 `json:"uuid"`
  12         Etag                      string                 `json:"etag"`
  13         CreatedAt                 time.Time              `json:"created_at"`
  14         ModifiedByUserUUID        string                 `json:"modified_by_user_uuid"`
  15         ModifiedAt                time.Time              `json:"modified_at"`
  16         Command                   []string               `json:"command"`
  17         ContainerImage            string                 `json:"container_image"`
  18         Cwd                       string                 `json:"cwd"`
  19         Environment               map[string]string      `json:"environment"`
  20         LockedByUUID              string                 `json:"locked_by_uuid"`
  21         LockCount                 int                    `json:"lock_count"`
  22         Mounts                    map[string]Mount       `json:"mounts"`
  23         Output                    string                 `json:"output"`
  24         OutputPath                string                 `json:"output_path"`
  25         OutputGlob                []string               `json:"output_glob"`
  26         Priority                  int64                  `json:"priority"`
  27         RuntimeConstraints        RuntimeConstraints     `json:"runtime_constraints"`
  28         State                     ContainerState         `json:"state"`
  29         SchedulingParameters      SchedulingParameters   `json:"scheduling_parameters"`
  30         ExitCode                  int                    `json:"exit_code"`
  31         RuntimeStatus             map[string]interface{} `json:"runtime_status"`
  32         StartedAt                 *time.Time             `json:"started_at"`  // nil if not yet started
  33         FinishedAt                *time.Time             `json:"finished_at"` // nil if not yet finished
  34         GatewayAddress            string                 `json:"gateway_address"`
  35         InteractiveSessionStarted bool                   `json:"interactive_session_started"`
  36         OutputStorageClasses      []string               `json:"output_storage_classes"`
  37         RuntimeUserUUID           string                 `json:"runtime_user_uuid"`
  38         RuntimeAuthScopes         []string               `json:"runtime_auth_scopes"`
  39         RuntimeToken              string                 `json:"runtime_token"`
  40         AuthUUID                  string                 `json:"auth_uuid"`
  41         Log                       string                 `json:"log"`
  42         Cost                      float64                `json:"cost"`
  43         SubrequestsCost           float64                `json:"subrequests_cost"`
  44 }
  45
  46 // ContainerRequest is an arvados#container_request resource.
  47 type ContainerRequest struct {
  48         UUID                    string                 `json:"uuid"`
  49         OwnerUUID               string                 `json:"owner_uuid"`
  50         CreatedAt               time.Time              `json:"created_at"`
  51         ModifiedByUserUUID      string                 `json:"modified_by_user_uuid"`
  52         ModifiedAt              time.Time              `json:"modified_at"`
  53         Etag                    string                 `json:"etag"`
  54         Name                    string                 `json:"name"`
  55         Description             string                 `json:"description"`
  56         Properties              map[string]interface{} `json:"properties"`
  57         State                   ContainerRequestState  `json:"state"`
  58         RequestingContainerUUID string                 `json:"requesting_container_uuid"`
  59         ContainerUUID           string                 `json:"container_uuid"`
  60         ContainerCountMax       int                    `json:"container_count_max"`
  61         Mounts                  map[string]Mount       `json:"mounts"`
  62         RuntimeConstraints      RuntimeConstraints     `json:"runtime_constraints"`
  63         SchedulingParameters    SchedulingParameters   `json:"scheduling_parameters"`
  64         ContainerImage          string                 `json:"container_image"`
  65         Environment             map[string]string      `json:"environment"`
  66         Cwd                     string                 `json:"cwd"`
  67         Command                 []string               `json:"command"`
  68         OutputPath              string                 `json:"output_path"`
  69         OutputGlob              []string               `json:"output_glob"`
  70         OutputName              string                 `json:"output_name"`
  71         OutputTTL               int                    `json:"output_ttl"`
  72         Priority                int                    `json:"priority"`
  73         UseExisting             bool                   `json:"use_existing"`
  74         LogUUID                 string                 `json:"log_uuid"`
  75         OutputUUID              string                 `json:"output_uuid"`
  76         RuntimeToken            string                 `json:"runtime_token"`
  77         ExpiresAt               time.Time              `json:"expires_at"`
  78         Filters                 []Filter               `json:"filters"`
  79         ContainerCount          int                    `json:"container_count"`
  80         OutputStorageClasses    []string               `json:"output_storage_classes"`
  81         OutputProperties        map[string]interface{} `json:"output_properties"`
  82         CumulativeCost          float64                `json:"cumulative_cost"`
  83 }
  84
  85 // Mount is special behavior to attach to a filesystem path or device.
  86 type Mount struct {
  87         Kind              string      `json:"kind"`
  88         Writable          bool        `json:"writable"`
  89         PortableDataHash  string      `json:"portable_data_hash"`
  90         UUID              string      `json:"uuid"`
  91         DeviceType        string      `json:"device_type"`
  92         Path              string      `json:"path"`
  93         Content           interface{} `json:"content"`
  94         ExcludeFromOutput bool        `json:"exclude_from_output"`
  95         Capacity          int64       `json:"capacity"`
  96 }
  97
  98 type GPURuntimeConstraints struct {
  99         Stack          string   `json:"stack"`
 100         DriverVersion  string   `json:"driver_version"`
 101         HardwareTarget []string `json:"hardware_target"`
 102         DeviceCount    int      `json:"device_count"`
 103         VRAM           int64    `json:"vram"`
 104 }
 105
 106 // RuntimeConstraints specify a container's compute resources (RAM,
 107 // CPU) and network connectivity.
 108 type RuntimeConstraints struct {
 109         API           bool                  `json:"API"`
 110         RAM           int64                 `json:"ram"`
 111         VCPUs         int                   `json:"vcpus"`
 112         KeepCacheRAM  int64                 `json:"keep_cache_ram"`
 113         KeepCacheDisk int64                 `json:"keep_cache_disk"`
 114         GPU           GPURuntimeConstraints `json:"gpu"`
 115 }
 116
 117 // SchedulingParameters specify a container's scheduling parameters
 118 // such as Partitions
 119 type SchedulingParameters struct {
 120         Partitions  []string `json:"partitions"`
 121         Preemptible bool     `json:"preemptible"`
 122         MaxRunTime  int      `json:"max_run_time"`
 123         Supervisor  bool     `json:"supervisor"`
 124 }
 125
 126 // ContainerList is an arvados#containerList resource.
 127 type ContainerList struct {
 128         Items          []Container `json:"items"`
 129         ItemsAvailable int         `json:"items_available"`
 130         Offset         int         `json:"offset"`
 131         Limit          int         `json:"limit"`
 132 }
 133
 134 // ContainerRequestList is an arvados#containerRequestList resource.
 135 type ContainerRequestList struct {
 136         Items          []ContainerRequest `json:"items"`
 137         ItemsAvailable int                `json:"items_available"`
 138         Offset         int                `json:"offset"`
 139         Limit          int                `json:"limit"`
 140 }
 141
 142 // ContainerState is a string corresponding to a valid Container state.
 143 type ContainerState string
 144
 145 const (
 146         ContainerStateQueued    = ContainerState("Queued")
 147         ContainerStateLocked    = ContainerState("Locked")
 148         ContainerStateRunning   = ContainerState("Running")
 149         ContainerStateComplete  = ContainerState("Complete")
 150         ContainerStateCancelled = ContainerState("Cancelled")
 151 )
 152
 153 // ContainerRequestState is a string corresponding to a valid Container Request state.
 154 type ContainerRequestState string
 155
 156 const (
 157         ContainerRequestStateUncomitted = ContainerRequestState("Uncommitted")
 158         ContainerRequestStateCommitted  = ContainerRequestState("Committed")
 159         ContainerRequestStateFinal      = ContainerRequestState("Final")
 160 )
 161
 162 type ContainerStatus struct {
 163         UUID             string         `json:"uuid"`
 164         State            ContainerState `json:"container_state"`
 165         SchedulingStatus string         `json:"scheduling_status"`
 166 }