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         ModifiedByClientUUID      string                 `json:"modified_by_client_uuid"`
  15         ModifiedByUserUUID        string                 `json:"modified_by_user_uuid"`
  16         ModifiedAt                time.Time              `json:"modified_at"`
  17         Command                   []string               `json:"command"`
  18         ContainerImage            string                 `json:"container_image"`
  19         Cwd                       string                 `json:"cwd"`
  20         Environment               map[string]string      `json:"environment"`
  21         LockedByUUID              string                 `json:"locked_by_uuid"`
  22         Mounts                    map[string]Mount       `json:"mounts"`
  23         Output                    string                 `json:"output"`
  24         OutputPath                string                 `json:"output_path"`
  25         Priority                  int64                  `json:"priority"`
  26         RuntimeConstraints        RuntimeConstraints     `json:"runtime_constraints"`
  27         State                     ContainerState         `json:"state"`
  28         SchedulingParameters      SchedulingParameters   `json:"scheduling_parameters"`
  29         ExitCode                  int                    `json:"exit_code"`
  30         RuntimeStatus             map[string]interface{} `json:"runtime_status"`
  31         StartedAt                 *time.Time             `json:"started_at"`  // nil if not yet started
  32         FinishedAt                *time.Time             `json:"finished_at"` // nil if not yet finished
  33         GatewayAddress            string                 `json:"gateway_address"`
  34         InteractiveSessionStarted bool                   `json:"interactive_session_started"`
  35         OutputStorageClasses      []string               `json:"output_storage_classes"`
  36         RuntimeUserUUID           string                 `json:"runtime_user_uuid"`
  37         RuntimeAuthScopes         []string               `json:"runtime_auth_scopes"`
  38         RuntimeToken              string                 `json:"runtime_token"`
  39         AuthUUID                  string                 `json:"auth_uuid"`
  40 }
  41
  42 // ContainerRequest is an arvados#container_request resource.
  43 type ContainerRequest struct {
  44         UUID                    string                 `json:"uuid"`
  45         OwnerUUID               string                 `json:"owner_uuid"`
  46         CreatedAt               time.Time              `json:"created_at"`
  47         ModifiedByClientUUID    string                 `json:"modified_by_client_uuid"`
  48         ModifiedByUserUUID      string                 `json:"modified_by_user_uuid"`
  49         ModifiedAt              time.Time              `json:"modified_at"`
  50         Href                    string                 `json:"href"`
  51         Etag                    string                 `json:"etag"`
  52         Name                    string                 `json:"name"`
  53         Description             string                 `json:"description"`
  54         Properties              map[string]interface{} `json:"properties"`
  55         State                   ContainerRequestState  `json:"state"`
  56         RequestingContainerUUID string                 `json:"requesting_container_uuid"`
  57         ContainerUUID           string                 `json:"container_uuid"`
  58         ContainerCountMax       int                    `json:"container_count_max"`
  59         Mounts                  map[string]Mount       `json:"mounts"`
  60         RuntimeConstraints      RuntimeConstraints     `json:"runtime_constraints"`
  61         SchedulingParameters    SchedulingParameters   `json:"scheduling_parameters"`
  62         ContainerImage          string                 `json:"container_image"`
  63         Environment             map[string]string      `json:"environment"`
  64         Cwd                     string                 `json:"cwd"`
  65         Command                 []string               `json:"command"`
  66         OutputPath              string                 `json:"output_path"`
  67         OutputName              string                 `json:"output_name"`
  68         OutputTTL               int                    `json:"output_ttl"`
  69         Priority                int                    `json:"priority"`
  70         UseExisting             bool                   `json:"use_existing"`
  71         LogUUID                 string                 `json:"log_uuid"`
  72         OutputUUID              string                 `json:"output_uuid"`
  73         RuntimeToken            string                 `json:"runtime_token"`
  74         ExpiresAt               time.Time              `json:"expires_at"`
  75         Filters                 []Filter               `json:"filters"`
  76         ContainerCount          int                    `json:"container_count"`
  77         OutputStorageClasses    []string               `json:"output_storage_classes"`
  78         OutputProperties        map[string]interface{} `json:"output_properties"`
  79 }
  80
  81 // Mount is special behavior to attach to a filesystem path or device.
  82 type Mount struct {
  83         Kind              string      `json:"kind"`
  84         Writable          bool        `json:"writable"`
  85         PortableDataHash  string      `json:"portable_data_hash"`
  86         UUID              string      `json:"uuid"`
  87         DeviceType        string      `json:"device_type"`
  88         Path              string      `json:"path"`
  89         Content           interface{} `json:"content"`
  90         ExcludeFromOutput bool        `json:"exclude_from_output"`
  91         Capacity          int64       `json:"capacity"`
  92         Commit            string      `json:"commit"`          // only if kind=="git_tree"
  93         RepositoryName    string      `json:"repository_name"` // only if kind=="git_tree"
  94         GitURL            string      `json:"git_url"`         // only if kind=="git_tree"
  95 }
  96
  97 type CUDARuntimeConstraints struct {
  98         DriverVersion      string `json:"driver_version"`
  99         HardwareCapability string `json:"hardware_capability"`
 100         DeviceCount        int    `json:"device_count"`
 101 }
 102
 103 // RuntimeConstraints specify a container's compute resources (RAM,
 104 // CPU) and network connectivity.
 105 type RuntimeConstraints struct {
 106         API          bool                   `json:"API"`
 107         RAM          int64                  `json:"ram"`
 108         VCPUs        int                    `json:"vcpus"`
 109         KeepCacheRAM int64                  `json:"keep_cache_ram"`
 110         CUDA         CUDARuntimeConstraints `json:"cuda"`
 111 }
 112
 113 // SchedulingParameters specify a container's scheduling parameters
 114 // such as Partitions
 115 type SchedulingParameters struct {
 116         Partitions  []string `json:"partitions"`
 117         Preemptible bool     `json:"preemptible"`
 118         MaxRunTime  int      `json:"max_run_time"`
 119 }
 120
 121 // ContainerList is an arvados#containerList resource.
 122 type ContainerList struct {
 123         Items          []Container `json:"items"`
 124         ItemsAvailable int         `json:"items_available"`
 125         Offset         int         `json:"offset"`
 126         Limit          int         `json:"limit"`
 127 }
 128
 129 // ContainerRequestList is an arvados#containerRequestList resource.
 130 type ContainerRequestList struct {
 131         Items          []ContainerRequest `json:"items"`
 132         ItemsAvailable int                `json:"items_available"`
 133         Offset         int                `json:"offset"`
 134         Limit          int                `json:"limit"`
 135 }
 136
 137 // ContainerState is a string corresponding to a valid Container state.
 138 type ContainerState string
 139
 140 const (
 141         ContainerStateQueued    = ContainerState("Queued")
 142         ContainerStateLocked    = ContainerState("Locked")
 143         ContainerStateRunning   = ContainerState("Running")
 144         ContainerStateComplete  = ContainerState("Complete")
 145         ContainerStateCancelled = ContainerState("Cancelled")
 146 )
 147
 148 // ContainerRequestState is a string corresponding to a valid Container Request state.
 149 type ContainerRequestState string
 150
 151 const (
 152         ContainerRequestStateUncomitted = ContainerRequestState("Uncommitted")
 153         ContainerRequestStateCommitted  = ContainerRequestState("Committed")
 154         ContainerRequestStateFinal      = ContainerRequestState("Final")
 155 )