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