1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
|
package server
import (
"net/http"
"github.com/containers/podman/v4/pkg/api/handlers/compat"
"github.com/gorilla/mux"
)
func (s *APIServer) registerExecHandlers(r *mux.Router) error {
// swagger:operation POST /containers/{name}/exec compat ContainerExec
// ---
// tags:
// - exec (compat)
// summary: Create an exec instance
// description: Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.
// parameters:
// - in: path
// name: name
// type: string
// required: true
// description: name of container
// - in: body
// name: control
// description: Attributes for create
// schema:
// type: object
// properties:
// AttachStdin:
// type: boolean
// description: Attach to stdin of the exec command
// AttachStdout:
// type: boolean
// description: Attach to stdout of the exec command
// AttachStderr:
// type: boolean
// description: Attach to stderr of the exec command
// DetachKeys:
// type: string
// description: |
// "Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _."
// Tty:
// type: boolean
// description: Allocate a pseudo-TTY
// Env:
// type: array
// description: A list of environment variables in the form ["VAR=value", ...]
// items:
// type: string
// Cmd:
// type: array
// description: Command to run, as a string or array of strings.
// items:
// type: string
// Privileged:
// type: boolean
// default: false
// description: Runs the exec process with extended privileges
// User:
// type: string
// description: |
// "The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid."
// WorkingDir:
// type: string
// description: The working directory for the exec process inside the container.
// produces:
// - application/json
// responses:
// 201:
// description: no error
// 404:
// $ref: "#/responses/containerNotFound"
// 409:
// description: container is paused
// 500:
// $ref: "#/responses/internalError"
r.Handle(VersionedPath("/containers/{name}/exec"), s.APIHandler(compat.ExecCreateHandler)).Methods(http.MethodPost)
// Added non version path to URI to support docker non versioned paths
r.Handle("/containers/{name}/exec", s.APIHandler(compat.ExecCreateHandler)).Methods(http.MethodPost)
// swagger:operation POST /exec/{id}/start compat ExecStart
// ---
// tags:
// - exec (compat)
// summary: Start an exec instance
// description: Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.
// parameters:
// - in: path
// name: id
// type: string
// required: true
// description: Exec instance ID
// - in: body
// name: control
// description: Attributes for start
// schema:
// type: object
// properties:
// Detach:
// type: boolean
// description: Detach from the command. Not presently supported.
// Tty:
// type: boolean
// description: Allocate a pseudo-TTY. Presently ignored.
// produces:
// - application/octet-stream
// responses:
// 200:
// description: no error
// 404:
// $ref: "#/responses/execSessionNotFound"
// 409:
// description: container is not running
// 500:
// $ref: "#/responses/internalError"
r.Handle(VersionedPath("/exec/{id}/start"), s.APIHandler(compat.ExecStartHandler)).Methods(http.MethodPost)
// Added non version path to URI to support docker non versioned paths
r.Handle("/exec/{id}/start", s.APIHandler(compat.ExecStartHandler)).Methods(http.MethodPost)
// swagger:operation POST /exec/{id}/resize compat ExecResize
// ---
// tags:
// - exec (compat)
// summary: Resize an exec instance
// description: |
// Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.
// parameters:
// - in: path
// name: id
// type: string
// required: true
// description: Exec instance ID
// - in: query
// name: h
// type: integer
// description: Height of the TTY session in characters
// - in: query
// name: w
// type: integer
// description: Width of the TTY session in characters
// - in: query
// name: running
// type: boolean
// required: false
// description: Ignore containers not running errors
// produces:
// - application/json
// responses:
// 201:
// description: no error
// 404:
// $ref: "#/responses/execSessionNotFound"
// 500:
// $ref: "#/responses/internalError"
r.Handle(VersionedPath("/exec/{id}/resize"), s.APIHandler(compat.ResizeTTY)).Methods(http.MethodPost)
// Added non version path to URI to support docker non versioned paths
r.Handle("/exec/{id}/resize", s.APIHandler(compat.ResizeTTY)).Methods(http.MethodPost)
// swagger:operation GET /exec/{id}/json compat ExecInspect
// ---
// tags:
// - exec (compat)
// summary: Inspect an exec instance
// description: Return low-level information about an exec instance.
// parameters:
// - in: path
// name: id
// type: string
// required: true
// description: Exec instance ID
// produces:
// - application/json
// responses:
// 200:
// $ref: "#/responses/execSessionInspect"
// 404:
// $ref: "#/responses/execSessionNotFound"
// 500:
// $ref: "#/responses/internalError"
r.Handle(VersionedPath("/exec/{id}/json"), s.APIHandler(compat.ExecInspectHandler)).Methods(http.MethodGet)
// Added non version path to URI to support docker non versioned paths
r.Handle("/exec/{id}/json", s.APIHandler(compat.ExecInspectHandler)).Methods(http.MethodGet)
/*
libpod api follows
*/
// swagger:operation POST /libpod/containers/{name}/exec libpod ContainerExecLibpod
// ---
// tags:
// - exec
// summary: Create an exec instance
// description: Create an exec session to run a command inside a running container. Exec sessions will be automatically removed 5 minutes after they exit.
// parameters:
// - in: path
// name: name
// type: string
// required: true
// description: name of container
// - in: body
// name: control
// description: Attributes for create
// schema:
// type: object
// properties:
// AttachStdin:
// type: boolean
// description: Attach to stdin of the exec command
// AttachStdout:
// type: boolean
// description: Attach to stdout of the exec command
// AttachStderr:
// type: boolean
// description: Attach to stderr of the exec command
// DetachKeys:
// type: string
// description: |
// "Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl-<value> where <value> is one of: a-z, @, ^, [, , or _."
// Tty:
// type: boolean
// description: Allocate a pseudo-TTY
// Env:
// type: array
// description: A list of environment variables in the form ["VAR=value", ...]
// items:
// type: string
// Cmd:
// type: array
// description: Command to run, as a string or array of strings.
// items:
// type: string
// Privileged:
// type: boolean
// default: false
// description: Runs the exec process with extended privileges
// User:
// type: string
// description: |
// "The user, and optionally, group to run the exec process inside the container. Format is one of: user, user:group, uid, or uid:gid."
// WorkingDir:
// type: string
// description: The working directory for the exec process inside the container.
// produces:
// - application/json
// responses:
// 201:
// description: no error
// 404:
// $ref: "#/responses/containerNotFound"
// 409:
// description: container is paused
// 500:
// $ref: "#/responses/internalError"
r.Handle(VersionedPath("/libpod/containers/{name}/exec"), s.APIHandler(compat.ExecCreateHandler)).Methods(http.MethodPost)
// swagger:operation POST /libpod/exec/{id}/start libpod ExecStartLibpod
// ---
// tags:
// - exec
// summary: Start an exec instance
// description: Starts a previously set up exec instance. If detach is true, this endpoint returns immediately after starting the command. Otherwise, it sets up an interactive session with the command.
// parameters:
// - in: path
// name: id
// type: string
// required: true
// description: Exec instance ID
// - in: body
// name: control
// description: Attributes for start
// schema:
// type: object
// properties:
// Detach:
// type: boolean
// description: Detach from the command.
// Tty:
// type: boolean
// description: Allocate a pseudo-TTY.
// h:
// type: integer
// description: Height of the TTY session in characters. Tty must be set to true to use it.
// w:
// type: integer
// description: Width of the TTY session in characters. Tty must be set to true to use it.
// produces:
// - application/json
// responses:
// 200:
// description: no error
// 404:
// $ref: "#/responses/execSessionNotFound"
// 409:
// description: container is not running.
// 500:
// $ref: "#/responses/internalError"
r.Handle(VersionedPath("/libpod/exec/{id}/start"), s.APIHandler(compat.ExecStartHandler)).Methods(http.MethodPost)
// swagger:operation POST /libpod/exec/{id}/resize libpod ExecResizeLibpod
// ---
// tags:
// - exec
// summary: Resize an exec instance
// description: |
// Resize the TTY session used by an exec instance. This endpoint only works if tty was specified as part of creating and starting the exec instance.
// parameters:
// - in: path
// name: id
// type: string
// required: true
// description: Exec instance ID
// - in: query
// name: h
// type: integer
// description: Height of the TTY session in characters
// - in: query
// name: w
// type: integer
// description: Width of the TTY session in characters
// produces:
// - application/json
// responses:
// 201:
// description: no error
// 404:
// $ref: "#/responses/execSessionNotFound"
// 500:
// $ref: "#/responses/internalError"
r.Handle(VersionedPath("/libpod/exec/{id}/resize"), s.APIHandler(compat.ResizeTTY)).Methods(http.MethodPost)
// swagger:operation GET /libpod/exec/{id}/json libpod ExecInspectLibpod
// ---
// tags:
// - exec
// summary: Inspect an exec instance
// description: Return low-level information about an exec instance.
// parameters:
// - in: path
// name: id
// type: string
// required: true
// description: Exec instance ID
// produces:
// - application/json
// responses:
// 200:
// description: no error
// 404:
// $ref: "#/responses/execSessionNotFound"
// 500:
// $ref: "#/responses/internalError"
r.Handle(VersionedPath("/libpod/exec/{id}/json"), s.APIHandler(compat.ExecInspectHandler)).Methods(http.MethodGet)
return nil
}
|
