You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@mesos.apache.org by kl...@apache.org on 2017/02/28 21:31:26 UTC
mesos git commit: Added debugging APIs to agent API docs.
Repository: mesos
Updated Branches:
refs/heads/master db7e52b34 -> 86f32a4be
Added debugging APIs to agent API docs.
Review: https://reviews.apache.org/r/57118
Project: http://git-wip-us.apache.org/repos/asf/mesos/repo
Commit: http://git-wip-us.apache.org/repos/asf/mesos/commit/86f32a4b
Tree: http://git-wip-us.apache.org/repos/asf/mesos/tree/86f32a4b
Diff: http://git-wip-us.apache.org/repos/asf/mesos/diff/86f32a4b
Branch: refs/heads/master
Commit: 86f32a4bee0ee981f8dfe1d46a3c86652bc1dd4b
Parents: db7e52b
Author: Kevin Klues <kl...@gmail.com>
Authored: Sun Feb 26 22:49:49 2017 -0800
Committer: Kevin Klues <kl...@gmail.com>
Committed: Tue Feb 28 13:30:58 2017 -0800
----------------------------------------------------------------------
docs/operator-http-api.md | 219 +++++++++++++++++++++++++++++++++++++++++
1 file changed, 219 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/mesos/blob/86f32a4b/docs/operator-http-api.md
----------------------------------------------------------------------
diff --git a/docs/operator-http-api.md b/docs/operator-http-api.md
index aa44994..506251b 100644
--- a/docs/operator-http-api.md
+++ b/docs/operator-http-api.md
@@ -3355,3 +3355,222 @@ KILL_NESTED_CONTAINER HTTP Response (JSON):
HTTP/1.1 200 OK
```
+
+### LAUNCH_NESTED_CONTAINER_SESSION
+
+This call launches a nested container whose lifetime is tied to the
+lifetime of the HTTP call establishing this connection. The STDOUT and
+STDERR of the nested container is streamed back to the client so long
+as the connection is active.
+
+```
+LAUNCH_NESTED_CONTAINER_SESSION HTTP Request (JSON):
+
+POST /api/v1 HTTP/1.1
+
+Host: agenthost:5051
+Content-Type: application/json
+Accept: application/recordio
+Message-Accept: application/json
+
+{
+ "type": "LAUNCH_NESTED_CONTAINER_SESSION",
+ "launch_nested_container_session": {
+ "container_id": {
+ "parent": {
+ "parent": {
+ "value": "bde04877-cb26-4277-976e-3ecf0c02e76b"
+ },
+ "value": "134bae93-cf5c-4938-87bf-f779bfcd0092"
+ },
+ "value": "e193a755-8528-4673-a05b-2cc2a01a8b94"
+ },
+ "command": {
+ "environment": {
+ "variables": [
+ {
+ "name": "ENV_VAR_KEY",
+ "type": "VALUE",
+ "value": "env_var_value"
+ }
+ ]
+ },
+ "shell": true,
+ "value": "while [ true ]; do echo $(date); sleep 1; done"
+ }
+ }
+}
+
+LAUNCH_NESTED_CONTAINER_SESSION HTTP Response (JSON):
+
+HTTP/1.1 200 OK
+
+Content-Type: application/recordio
+Message-Content-Type: application/json
+
+90
+{
+ "type":"DATA",
+ "data": {
+ "type":"STDOUT",
+ "data": "TW9uIEZlYiAyNyAwNzozOTozOCBVVEMgMjAxNwo="
+ }
+}90
+{
+ "type":"DATA",
+ "data": {
+ "type":"STDOUT",
+ "data": "TW9uIEZlYiAyNyAwNzozOTozOSBVVEMgMjAxNwo="
+ }
+}90
+{
+ "type":"DATA",
+ "data": {
+ "type":"STDERR",
+ "data": "TW9uIEZlYiAyNyAwNzozOTo0MCBVVEMgMjAxNwo="
+ }
+}
+...
+
+```
+
+### ATTACH_CONTAINER_INPUT
+
+This call attaches to the STDIN of the primary process of a container
+and streams input to it. This call can only be made against containers
+that have been launched with an associated IOSwitchboard (i.e. nested
+containers launched via a LAUNCH_NESTED_CONTAINER_SESSION call or
+normal containers launched with a TTYInfo in their ContainerInfo).
+Only one ATTACH_CONTAINER_INPUT call can be active for a given
+container at a time. Subsequent attempts to attach will fail.
+
+The first message sent over an ATTACH_CONTAINER_INPUT stream must be
+of type CONTAINER_ID and contain the ContainerID of the container
+being attached to. Subsequent messages must be of type PROCESS_IO, but
+they may contain subtypes of either DATA or CONTROL. DATA messages
+must be of type STDIN and contain the actual data to stream to the
+STDIN of the container beinga attached to. Currently, the only valid
+CONTROL message sends a heartbeat to keep the connection alive. We may
+add more CONTROL messages in the future.
+
+```
+ATTACH_CONTAINER_INPUT HTTP Request (JSON):
+
+POST /api/v1 HTTP/1.1
+
+Host: agenthost:5051
+Content-Type: application/recordio
+Message-Content-Type: application/json
+Accept: application/json
+
+214
+{
+ "type": "ATTACH_CONTAINER_INPUT",
+ "attach_container_input": {
+ "type": "CONTAINER_ID",
+ "container_id": {
+ "value": "da737efb-a9d4-4622-84ef-f55eb07b861a"
+ }
+ }
+}163
+{
+ "type": "ATTACH_CONTAINER_INPUT",
+ "attach_container_input": {
+ "type": "PROCESS_IO",
+ "process_io": {
+ "type": "DATA",
+ "data": {
+ "type": "STDIN",
+ "data": "dGVzdAo="
+ }
+ }
+ }
+}210
+{
+ "type":
+ "ATTACH_CONTAINER_INPUT",
+ "attach_container_input": {
+ "type": "PROCESS_IO",
+ "process_io": {
+ "type": "CONTROL",
+ "control": {
+ "type": "HEARTBEAT",
+ "heartbeat": {
+ "interval": {
+ "nanoseconds": 30000000000
+ }
+ }
+ }
+ }
+ }
+}
+...
+
+ATTACH_CONTAINER_INPUT HTTP Response (JSON):
+
+HTTP/1.1 200 OK
+
+```
+
+### ATTACH_CONTAINER_OUTPUT
+
+This call attaches to the STDOUT and STDERR of the primary process of
+a container and streams its output back to the client. This call can
+only be made against containers that have been launched with an
+associated IOSwitchboard (i.e. nested containers launched via a
+LAUNCH_NESTED_CONTAINER_SESSION call or normal containers launched
+with a TTYInfo in their ContainerInfo field). Multiple
+ATTACH_CONTAINER_OUTPUT calls can be active for a given container at
+once.
+
+```
+ATTACH_CONTAINER_OUTPUT HTTP Request (JSON):
+
+POST /api/v1 HTTP/1.1
+
+Host: agenthost:5051
+Content-Type: application/json
+Accept: application/recordio
+Message-Accept: application/json
+
+{
+ "type": "ATTACH_CONTAINER_OUTPUT",
+ "attach_container_output": {
+ "container_id": {
+ "value": "e193a755-8528-4673-a05b-2cc2a01a8b94"
+ }
+ }
+}
+
+ATTACH_CONTAINER_OUTPUT HTTP Response (JSON):
+
+HTTP/1.1 200 OK
+
+Content-Type: application/recordio
+Message-Content-Type: application/json
+
+90
+{
+ "type":"DATA",
+ "data": {
+ "type":"STDOUT",
+ "data": "TW9uIEZlYiAyNyAwNzozOTozOCBVVEMgMjAxNwo="
+ }
+}90
+{
+ "type":"DATA",
+ "data": {
+ "type":"STDOUT",
+ "data": "TW9uIEZlYiAyNyAwNzozOTozOSBVVEMgMjAxNwo="
+ }
+}90
+{
+ "type":"DATA",
+ "data": {
+ "type":"STDERR",
+ "data": "TW9uIEZlYiAyNyAwNzozOTo0MCBVVEMgMjAxNwo="
+ }
+}
+...
+
+```