1 // Copyright (C) The Arvados Authors. All rights reserved.
3 // SPDX-License-Identifier: Apache-2.0
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"`
37 // ContainerRequest is an arvados#container_request resource.
38 type ContainerRequest struct {
39 UUID string `json:"uuid"`
40 OwnerUUID string `json:"owner_uuid"`
41 CreatedAt time.Time `json:"created_at"`
42 ModifiedByClientUUID string `json:"modified_by_client_uuid"`
43 ModifiedByUserUUID string `json:"modified_by_user_uuid"`
44 ModifiedAt time.Time `json:"modified_at"`
45 Href string `json:"href"`
46 Kind string `json:"kind"`
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"`
75 // Mount is special behavior to attach to a filesystem path or device.
77 Kind string `json:"kind"`
78 Writable bool `json:"writable"`
79 PortableDataHash string `json:"portable_data_hash"`
80 UUID string `json:"uuid"`
81 DeviceType string `json:"device_type"`
82 Path string `json:"path"`
83 Content interface{} `json:"content"`
84 ExcludeFromOutput bool `json:"exclude_from_output"`
85 Capacity int64 `json:"capacity"`
86 Commit string `json:"commit"` // only if kind=="git_tree"
87 RepositoryName string `json:"repository_name"` // only if kind=="git_tree"
88 GitURL string `json:"git_url"` // only if kind=="git_tree"
91 // RuntimeConstraints specify a container's compute resources (RAM,
92 // CPU) and network connectivity.
93 type RuntimeConstraints struct {
95 RAM int64 `json:"ram"`
96 VCPUs int `json:"vcpus"`
97 KeepCacheRAM int64 `json:"keep_cache_ram"`
100 // SchedulingParameters specify a container's scheduling parameters
101 // such as Partitions
102 type SchedulingParameters struct {
103 Partitions []string `json:"partitions"`
104 Preemptible bool `json:"preemptible"`
105 MaxRunTime int `json:"max_run_time"`
108 // ContainerList is an arvados#containerList resource.
109 type ContainerList struct {
110 Items []Container `json:"items"`
111 ItemsAvailable int `json:"items_available"`
112 Offset int `json:"offset"`
113 Limit int `json:"limit"`
116 // ContainerRequestList is an arvados#containerRequestList resource.
117 type ContainerRequestList struct {
118 Items []ContainerRequest `json:"items"`
119 ItemsAvailable int `json:"items_available"`
120 Offset int `json:"offset"`
121 Limit int `json:"limit"`
124 // ContainerState is a string corresponding to a valid Container state.
125 type ContainerState string
128 ContainerStateQueued = ContainerState("Queued")
129 ContainerStateLocked = ContainerState("Locked")
130 ContainerStateRunning = ContainerState("Running")
131 ContainerStateComplete = ContainerState("Complete")
132 ContainerStateCancelled = ContainerState("Cancelled")
135 // ContainerRequestState is a string corresponding to a valid Container Request state.
136 type ContainerRequestState string
139 ContainerRequestStateUncomitted = ContainerRequestState("Uncommitted")
140 ContainerRequestStateCommitted = ContainerRequestState("Committed")
141 ContainerRequestStateFinal = ContainerRequestState("Final")