Pipeline Ingress

The ingress service to invoke ML pipeline. A web-server with two end-points:

GET: /status -> status check

POST: /train -> train pipeline invocation trigger request with the metadata payload

POST: /predict -> predict pipeline invocation trigger request with the metadata payload

Modus Operandi

1. Validate input payload:
2. Push the payload to a message bus' topic
3. Return 202 as response in case of success

How to run

!Note! It requires an existing GCP, or AWS account with activated pubsub/SNS API, service account (SA) with PubSub/SNS Write permissions and a PubSub/SNS topic.

Once SA is created, generate and download the access key to ${PATH_TO_SERVICE_ACCOUNT_KEY}/key-pubsub.json.

Execute:

make build PLATFORM=gcp

afterwards:

make PROJECT_ID=<YOUR_GCO_PROJECT_ID> run

or alternatively, for the sake of testing, run

make PROJECT_ID=<YOUR_GCO_PROJECT_ID> test-run

HTTP Response Codes

Endpoint	Method	HTTP Status Code	Comment
/status	GET	200	-
/status	POST,PUT,PATCH,DELETE	405	Not supported methods
/train /predict	POST	202	Request accepted
/train /predict	POST	400	Faulty JSON submitted with request
/train /predict	GET,PUT,PATCH,DELETE	405	Not supported methods
/train /predict	POST	422	Submitted JSON doesn't pass validation/comply with the input schema

Input Schema

Input JSON schemas per endpoint can be found here:

• /train

• /predict

Response Schema

POST requests sent to /train and /predict lead to responses of the following structure:

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "definitions": {
        "uuid4": {
            "oneOf": [
                {
                    "type": "string",
                    "pattern": "^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-4[a-fA-F0-9]{3}-[89abAB][a-fA-F0-9]{3}-[a-fA-F0-9]{12}$"
                },
                {
                    "type": "null"
                }
            ]
        }
    },
    "type": "object",
    "additionalProperties": false,
    "required": [
        "errors",
        "submitted_id"
    ],
    "properties": {
        "errors": {
            "type": "array",
            "items": {
                "oneOf": [
                    {
                        "type": "string"
                    },
                    {
                        "type": "null"
                    }
                ]
            }
        },
        "submitted_id": {
            "type": "array",
            "items": {
                "$ref": "#/definitions/uuid4"
            }
        }
    }
}

Tests

Health check

curl -iX GET "http://0.0.0.0:8080/status"

Expected output:

HTTP/1.1 200 OK
Access-Control-Allow-Methods: GET
Date: YOUR CURRENT DATE/TIME
Content-Length: 0

Integration test

1. Create the PubSub topic called trigger_0cba82ff-9790-454d-b7b9-22570e7ba28c
2. Execute make PROJECT_ID=<YOUR_GCO_PROJECT_ID> run
3. Run

• to trigger train pipeline:

curl -H "Accept: application/json" -H "Content-Type: application/json" \
    -iX POST "http://0.0.0.0:8080/train" -d '{
  "project_id": "0cba82ff-9790-454d-b7b9-22570e7ba28c",
  "code_hash": "8c2f3d3c5dd853231c7429b099347d13c8bb2c37",
  "pipeline_config": [
    {
      "data": {
        "location": {
          "source": "gcs://test/train.csv"
        },
        "prep_config": {}
      },
      "model": {
        "hyperparameters": {},
        "version": "v1"
      }
    }
  ]
}'

Expected output:

HTTP/1.1 202 Accepted
Access-Control-Allow-Headers: Content-Type, Content-Length, Accept-Encoding
Access-Control-Allow-Methods: POST
Content-Type: application/json
Date: YOUR CURRENT DATE/TIME
Content-Length: 69

{"errors":[],"submitted_id":["b441141f-bce1-4552-9458-999d2b8f6fda"]}

• to trigger predict pipeline:

curl -H "Accept: application/json" -H "Content-Type: application/json" \
    -iX POST "http://0.0.0.0:8080/predict" -d '{
  "project_id": "0cba82ff-9790-454d-b7b9-22570e7ba28c",
  "train_id": "b441141f-bce1-4552-9458-999d2b8f6fda",
  "pipeline_config": [
    {
      "data": {
        "location": {
          "source": "gcs://test/train.csv",
          "destination": "gcs://prediction/train.csv"
        }
      }
    }
  ]
}'

Expected output:

HTTP/1.1 202 Accepted
Access-Control-Allow-Headers: Content-Type, Content-Length, Accept-Encoding
Access-Control-Allow-Methods: POST
Content-Type: application/json
Date: YOUR CURRENT DATE/TIME
Content-Length: 69

{"errors":[],"submitted_id":["3aab10b8-a42b-4938-aea8-fd398d2c2f01"]}

In the return payload, the submitted_id is a list UUID4 index, it must be different from the ones above.