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 }
  35
  36 // ContainerRequest is an arvados#container_request resource.
  37 type ContainerRequest struct {
  38         UUID                    string                 `json:"uuid"`
  39         OwnerUUID               string                 `json:"owner_uuid"`
  40         CreatedAt               time.Time              `json:"created_at"`
  41         ModifiedByClientUUID    string                 `json:"modified_by_client_uuid"`
  42         ModifiedByUserUUID      string                 `json:"modified_by_user_uuid"`
  43         ModifiedAt              time.Time              `json:"modified_at"`
  44         Href                    string                 `json:"href"`
  45         Kind                    string                 `json:"kind"`
  46         Etag                    string                 `json:"etag"`
  47         Name                    string                 `json:"name"`
  48         Description             string                 `json:"description"`
  49         Properties              map[string]interface{} `json:"properties"`
  50         State                   ContainerRequestState  `json:"state"`
  51         RequestingContainerUUID string                 `json:"requesting_container_uuid"`
  52         ContainerUUID           string                 `json:"container_uuid"`
  53         ContainerCountMax       int                    `json:"container_count_max"`
  54         Mounts                  map[string]Mount       `json:"mounts"`
  55         RuntimeConstraints      RuntimeConstraints     `json:"runtime_constraints"`
  56         SchedulingParameters    SchedulingParameters   `json:"scheduling_parameters"`
  57         ContainerImage          string                 `json:"container_image"`
  58         Environment             map[string]string      `json:"environment"`
  59         Cwd                     string                 `json:"cwd"`
  60         Command                 []string               `json:"command"`
  61         OutputPath              string                 `json:"output_path"`
  62         OutputName              string                 `json:"output_name"`
  63         OutputTTL               int                    `json:"output_ttl"`
  64         Priority                int                    `json:"priority"`
  65         UseExisting             bool                   `json:"use_existing"`
  66         LogUUID                 string                 `json:"log_uuid"`
  67         OutputUUID              string                 `json:"output_uuid"`
  68         RuntimeToken            string                 `json:"runtime_token"`
  69 }
  70
  71 // Mount is special behavior to attach to a filesystem path or device.
  72 type Mount struct {
  73         Kind              string      `json:"kind"`
  74         Writable          bool        `json:"writable"`
  75         PortableDataHash  string      `json:"portable_data_hash"`
  76         UUID              string      `json:"uuid"`
  77         DeviceType        string      `json:"device_type"`
  78         Path              string      `json:"path"`
  79         Content           interface{} `json:"content"`
  80         ExcludeFromOutput bool        `json:"exclude_from_output"`
  81         Capacity          int64       `json:"capacity"`
  82         Commit            string      `json:"commit"`          // only if kind=="git_tree"
  83         RepositoryName    string      `json:"repository_name"` // only if kind=="git_tree"
  84         GitURL            string      `json:"git_url"`         // only if kind=="git_tree"
  85 }
  86
  87 // RuntimeConstraints specify a container's compute resources (RAM,
  88 // CPU) and network connectivity.
  89 type RuntimeConstraints struct {
  90         API          *bool
  91         RAM          int64 `json:"ram"`
  92         VCPUs        int   `json:"vcpus"`
  93         KeepCacheRAM int64 `json:"keep_cache_ram"`
  94 }
  95
  96 // SchedulingParameters specify a container's scheduling parameters
  97 // such as Partitions
  98 type SchedulingParameters struct {
  99         Partitions  []string `json:"partitions"`
 100         Preemptible bool     `json:"preemptible"`
 101         MaxRunTime  int      `json:"max_run_time"`
 102 }
 103
 104 // ContainerList is an arvados#containerList resource.
 105 type ContainerList struct {
 106         Items          []Container `json:"items"`
 107         ItemsAvailable int         `json:"items_available"`
 108         Offset         int         `json:"offset"`
 109         Limit          int         `json:"limit"`
 110 }
 111
 112 // ContainerRequestList is an arvados#containerRequestList resource.
 113 type ContainerRequestList struct {
 114         Items          []ContainerRequest `json:"items"`
 115         ItemsAvailable int                `json:"items_available"`
 116         Offset         int                `json:"offset"`
 117         Limit          int                `json:"limit"`
 118 }
 119
 120 // ContainerState is a string corresponding to a valid Container state.
 121 type ContainerState string
 122
 123 const (
 124         ContainerStateQueued    = ContainerState("Queued")
 125         ContainerStateLocked    = ContainerState("Locked")
 126         ContainerStateRunning   = ContainerState("Running")
 127         ContainerStateComplete  = ContainerState("Complete")
 128         ContainerStateCancelled = ContainerState("Cancelled")
 129 )
 130
 131 // ContainerRequestState is a string corresponding to a valid Container Request state.
 132 type ContainerRequestState string
 133
 134 const (
 135         ContainerRequestStateUncomitted = ContainerRequestState("Uncommitted")
 136         ContainerRequestStateCommitted  = ContainerRequestState("Committed")
 137         ContainerRequestStateFinal      = ContainerRequestState("Final")
 138 )