pman command: run

pman command: run

Abstract

This page describes the run command to pman. It is used to spawn a process on the underlying shell/OS.

Preconditions

• This page assumes that pman is listening on: 172.17.0.2:5010.
• Make sure that pman has been started (see here for more info):

pman --rawmode 1 --http  --port 5010 --listeners 12

msg summary

The msg payload of the REST interaction with pman is:

{  "action": "run",
        "meta": {
                "cmd":      "cal 7 1970",
                "auid":     "rudolphpienaar",
                "jid":      "cal-job-1234",
                "threaded": true
        }
}

run

purl calling syntax

The real purpose of pman is to manage processes. Let's send it a simple job, the UNIX calendar command to simply print a month in a given year. In this case, the command we wish to run is cal 7 1970.

purl --verb POST --raw --http 172.17.0.2:5010/api/v1/cmd --jsonwrapper 'payload' --msg \
'{  "action": "run",
        "meta": {
                "cmd":      "cal 7 1970",
                "auid":     "rudolphpienaar",
                "jid":      "cal-job-1234",
                "threaded": true
        }
}' --quiet --jsonpprintindent 4

Using the dockerized version of purl

To use the dockerized version of purl, and assuming a pman on the given IP:

Using the source repo

If you have cloned the source repo, you can cd to the root directory and execute the docker helper scripts in the docker-bin directory.

docker-bin/purl --verb POST --raw --http 172.17.0.2:5010/api/v1/cmd --jsonwrapper 'payload' --msg \
'{  "action": "run",
        "meta": {
                "cmd":      "cal 7 1970",
                "auid":     "rudolphpienaar",
                "jid":      "cal-job-1234",
                "threaded": true
        }
}' --quiet --jsonpprintindent 4

Calling docker directly

The helper script just creates a docker run command line string. You can run this string directly without using the helper script and directly calling the docker app:

docker run --name pman -v /home:/Users --rm -ti fnndsc/pman purl --verb POST --raw --http 172.17.0.2:5010/api/v1/cmd --jsonwrapper 'payload' --msg \
'{  "action": "run",
        "meta": {
                "cmd":      "cal 7 1970",
                "auid":     "rudolphpienaar",
                "jid":      "cal-job-1234",
                "threaded": true
        }
}' --quiet --jsonpprintindent 4

return payload

The above call returns the JSON string:

{
    "meta": {
        "jid": "cal-job-1234",
        "threaded": true,
        "cmd": "cal 7 1970",
        "auid": "rudolphpienaar"
    },
    "status": true,
    "path": "/api/v1/cmd",
    "jobRootDir": "20170303164938.122651_6e09943c-6fc0-45c8-b088-2394e5886b69",
    "receivedByServer": [
        "POST /api/v1/cmd HTTP/1.1\r",
        "Host: 172.17.0.2:5010\r",
        "User-Agent: PycURL/7.43.0 libcurl/7.47.0 GnuTLS/3.4.10 zlib/1.2.8 libidn/1.32 librtmp/2.3\r",
        "Accept: */*\r",
        "Content-type: application/vnd.collection+json\r",
        "Content-Length: 128\r",
        "\r",
        "{\"payload\": {\"meta\": {\"jid\": \"cal-job-1234\", \"threaded\": true, \"cmd\": \"cal 7 1970\", \"auid\": \"rudolphpienaar\"}, \"action\": \"run\"}}"
    ],
    "action": "run",
    "payloadsize": 128,
    "RESTverb": "POST",
    "RESTheader": "POST /api/v1/cmd HTTP/1.1\r"
}

--30--