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