Skip to main content
Version: Next

Workflow Inputs & Outputs

General Structure​

Cumulus uses a common format for all inputs and outputs to workflows. The same format is used for input and output from workflow steps. The common format consists of a JSON object which holds all necessary information about the task execution and AWS environment. Tasks return objects identical in format to their input with the exception of a task-specific payload field. Tasks may also augment their execution metadata.

Cumulus Message Adapter​

The Cumulus Message Adapter and Cumulus Message Adapter libraries help task developers integrate their tasks into a Cumulus workflow. These libraries adapt input and outputs from tasks into the Cumulus Message format. The Scheduler service creates the initial event message by combining the collection configuration, external resource configuration, workflow configuration, and deployment environment settings. The subsequent workflow messages between tasks must conform to the message schema. By using the Cumulus Message Adapter, individual task Lambda functions only receive the input and output specifically configured for the task, and not non-task-related message fields.

The Cumulus Message Adapter libraries are called by the tasks with a callback function containing the business logic of the task as a parameter. They first adapt the incoming message to a format more easily consumable by Cumulus tasks, then invoke the task, and then adapt the task response back to the Cumulus message protocol to be sent to the next task.

A task's Lambda function can be configured to include a Cumulus Message Adapter library which constructs input/output messages and resolves task configurations. The CMA can then be included in one of several ways:

Lambda Layer​

In order to make use of this configuration, a Lambda layer must be uploaded to your account. Due to platform restrictions, Core cannot currently support sharable public layers, however you can deploy the appropriate version from the release page in two ways:

Once you've deployed the layer, integrate the CMA layer with your Lambdas:

  • If using the cumulus module, set the cumulus_message_adapter_lambda_layer_version_arn in your .tfvars file to integrate the CMA layer with all core Cumulus lambdas.
  • If including your own Lambda or ECS task Terraform modules, specify the CMA layer ARN in the Terraform resource definitions. Also, make sure to set the CUMULUS_MESSAGE_ADAPTER_DIR environment variable for the task to /opt for the CMA integration to work properly.

In the future if you wish to update/change the CMA version you will need to update the deployed CMA, and update the layer configuration for the impacted Lambdas as needed.

note

Updating/removing a layer does not change a deployed Lambda, so to update the CMA you should deploy a new version of the CMA layer, update the associated Lambda configuration to reference the new CMA version, and re-deploy your Lambdas.

Manual Addition​

You can include the CMA package in the Lambda code in the cumulus-message-adapter sub-directory in your lambda .zip, for any Lambda runtime that includes a python runtime. python 2 is included in Lambda runtimes that use Amazon Linux, however Amazon Linux 2 will not support this directly.

python runtime

It is expected that upcoming Cumulus releases will update the CMA layer to include a python runtime.

If you are manually adding the message adapter to your source and utilizing the CMA, you should set the Lambda's CUMULUS_MESSAGE_ADAPTER_DIR environment variable to target the installation path for the CMA.

CMA Input/Output​

Input to the task application code is a json object with keys:

  • input: By default, the incoming payload is the payload output from the previous task, or it can be a portion of the payload as configured for the task in the corresponding .tf workflow definition file.
  • config: Task-specific configuration object with URL templates resolved.

Output from the task application code is returned in and placed in the payload key by default, but the config key can also be used to return just a portion of the task output.

CMA configuration​

As of Cumulus > 1.15 and CMA > v1.1.1, configuration of the CMA is expected to be driven by AWS Step Function Parameters.

Using the CMA package with the Lambda by any of the above mentioned methods (Lambda Layers, manual) requires configuration for its various features via a specific Step Function Parameters configuration format (see sample workflows in the examples cumulus-tf source for more examples):

{
  "cma": {
    "event.$": "$",
    "ReplaceConfig": "{some config}",
    "task_config": "{some config}"
  }
}

The "event.$": "$" parameter is required as it passes the entire incoming message to the CMA client library for parsing, and the CMA itself to convert the incoming message into a Cumulus message for use in the function.

The following are the CMA's current configuration settings:

ReplaceConfig (Cumulus Remote Message)​

Because of the potential size of a Cumulus message, mainly the payload field, a task can be set via configuration to store a portion of its output on S3 with a message key Remote Message that defines how to retrieve it and an empty JSON object {} in its place. If the portion of the message targeted exceeds the configured MaxSize (defaults to 0 bytes) it will be written to S3.

The CMA remote message functionality can be configured using parameters in several ways:

Partial Message​

Setting the Path/Target path in the ReplaceConfig parameter (and optionally a non-default MaxSize)

{
  "DiscoverGranules": {
    "Parameters": {
      "cma": {
        "event.$": "$",
        "ReplaceConfig": {
          "MaxSize": 1,
          "Path": "$.payload",
          "TargetPath": "$.payload"
        }
      }
    }
  }
}

will result in any payload output larger than the MaxSize (in bytes) to be written to S3. The CMA will then mark that the key has been replaced via a replace key on the event. When the CMA picks up the replace key in future steps, it will attempt to retrieve the output from S3 and write it back to payload.

Note that you can optionally use a different TargetPath than Path, however as the target is a JSON path there must be a key to target for replacement in the output of that step. Also note that the JSON path specified must target one node, otherwise the CMA will error, as it does not support multiple replacement targets.

If TargetPath is omitted, it will default to the value for Path.

Full Message​

Setting the following parameters for a lambda:

DiscoverGranules:
  Parameters:
    cma:
      event.$: '$'
      ReplaceConfig:
        FullMessage: true

will result in the CMA assuming the entire inbound message should be stored to S3 if it exceeds the default max size.

This is effectively the same as doing:

{
  "DiscoverGranules": {
    "Parameters": {
      "cma": {
        "event.$": "$",
        "ReplaceConfig": {
          "MaxSize": 0,
          "Path": "$",
          "TargetPath": "$"
        }
      }
    }
  }
}

Cumulus Message example​

{
  "task_config": {
    "inlinestr": "prefix{meta.foo}suffix",
    "array": "{[$.meta.foo]}",
    "object": "{$.meta}"
  },
  "cumulus_meta": {
    "message_source": "sfn",
    "state_machine": "arn:aws:states:us-east-1:1234:stateMachine:MySfn",
    "execution_name": "MyExecution__id-1234",
    "id": "id-1234"
  },
  "meta": {
    "foo": "bar"
  },
  "payload": {
    "anykey": "anyvalue"
  }
}

Cumulus Remote Message example​

The message may contain a reference to an S3 Bucket, Key and TargetPath as follows:

{
  "replace": {
    "Bucket": "cumulus-bucket",
    "Key": "my-large-event.json",
    "TargetPath": "$"
  },
  "cumulus_meta": {}
}

task_config​

This configuration key contains the input/output configuration values for definition of inputs/outputs via URL paths. Important: These values are all relative to json object configured for event.$.

This configuration's behavior is outlined in the CMA step description below.

The configuration should follow the format:

{
  "FunctionName": {
    "Parameters": {
      "cma": {
        "event.$": "$",
        "other_cma_configuration": "<config object>",
        "task_config": "<task config>"
      }
    }
  }
}

Example:

{
  "StepFunction": {
    "Parameters": {
      "cma": {
        "event.$": "$",
        "task_config": {
          "sfnEnd": true,
          "stack": "{$.meta.stack}",
          "bucket": "{$.meta.buckets.internal.name}",
          "stateMachine": "{$.cumulus_meta.state_machine}",
          "executionName": "{$.cumulus_meta.execution_name}",
          "cumulus_message": {
            "input": "{$}"
          }
        }
      }
    }
  }
}

Cumulus Message Adapter Steps​

1. Reformat AWS Step Function message into Cumulus Message​

Due to the way AWS handles Parameterized messages, when Parameters are used the CMA takes an inbound message:

{
  "resource": "arn:aws:lambda:us-east-1:<lambda arn values>",
  "input": {
    "Other Parameter": {},
    "cma": {
      "ConfigKey": {
        "config values": "some config values"
      },
      "event": {
        "cumulus_meta": {},
        "payload": {},
        "meta": {},
        "exception": {}
      }
    }
  }
}

and takes the following actions:

  • Takes the object at input.cma.event and makes it the full input
  • Merges all of the keys except event under input.cma into the parent input object

This results in the incoming message (presumably a Cumulus message) with any cma configuration parameters merged in being passed to the CMA. All other parameterized values defined outside of the cma key are ignored

2. Resolve Remote Messages​

If the incoming Cumulus message has a replace key value, the CMA will attempt to pull the payload from S3,

For example, if the incoming contains the following:

  "meta": {
    "foo": {}
  },
  "replace": {
    "TargetPath": "$.meta.foo",
    "Bucket": "some_bucket",
    "Key": "events/some-event-id"
  }

The CMA will attempt to pull the file stored at Bucket/Key and replace the value at TargetPath, then remove the replace object entirely and continue.

3. Resolve URL templates in the task configuration​

In the workflow configuration (defined under the task_config key), each task has its own configuration, and it can use URL template as a value to achieve simplicity or for values only available at execution time. The Cumulus Message Adapter resolves the URL templates (relative to the event configuration key) and then passes message to next task. For example, given a task which has the following configuration:

{
  "Parameters": {
    "cma": {
      "event.$": "$",
      "task_config": {
        "provider": "{$.meta.provider}",
        "inlinestr": "prefix{meta.foo}suffix",
        "array": "{[$.meta.foo]}",
        "object": "{$.meta}"
      }
    }
  }
}

and and incoming message that contains:

{
  "meta": {
    "foo": "bar",
    "provider": {
      "id": "FOO_DAAC",
      "anykey": "anyvalue"
    }
  }
}

The corresponding Cumulus Message would contain:

"meta": {
  "foo": "bar",
  "provider": {
    "id": "FOO_DAAC",
    "anykey": "anyvalue"
  }
},
"task_config": {
  "provider": "{$.meta.provider}",
  "inlinestr": "prefix{meta.foo}suffix",
  "array": "{[$.meta.foo]}",
  "object": "{$.meta}"
}

The message sent to the task would be:

"config" : {
  "provider": {
    "id": "FOO_DAAC",
    "anykey": "anyvalue"
  },
  "inlinestr": "prefixbarsuffix",
  "array": ["bar"],
  "object": {
    "foo": "bar",
    "provider": {
      "id": "FOO_DAAC",
      "anykey": "anyvalue"
      }
  },
},
"input": "{...}"

URL template variables replace dotted paths inside curly brackets with their corresponding value. If the Cumulus Message Adapter cannot resolve a value, it will ignore the template, leaving it verbatim in the string. While seemingly complex, this allows significant decoupling of Tasks from one another and the data that drives them. Tasks are able to easily receive runtime configuration produced by previously run tasks and domain data.

4. Resolve task input​

By default, the incoming payload is the payload from the previous task. The task can also be configured to use a portion of the payload its input message. For example, given a task specifies cma.task_config.cumulus_message.input:

    ExampleTask:
      Parameters:
        cma:
          event.$: '$'
          task_config:
            cumulus_message:
                input: '{$.payload.foo}'

The task configuration in the message would be:

    {
      "task_config": {
        "cumulus_message": {
          "input": "{$.payload.foo}"
        }
      },
      "payload": {
        "foo": {
          "anykey": "anyvalue"
        }
      }
    }

The Cumulus Message Adapter will resolve the task input, instead of sending the whole payload as task input, the task input would be:

    {
      "input" : {
        "anykey": "anyvalue"
      },
      "config": {...}
    }

5. Resolve task output​

By default, the task's return value is the next payload. However, the workflow task configuration can specify a portion of the return value as the next payload, and can also augment values to other fields. Based on the task configuration under cma.task_config.cumulus_message.outputs, the Message Adapter uses a task's return value to output a message as configured by the task-specific config defined under cma.task_config. The Message Adapter dispatches a "source" to a "destination" as defined by URL templates stored in the task-specific cumulus_message.outputs. The value of the task's return value at the "source" URL is used to create or replace the value of the task's return value at the "destination" URL. For example, given a task specifies cumulus_message.output in its workflow configuration as follows:

{
  "ExampleTask": {
    "Parameters": {
      "cma": {
        "event.$": "$",
        "task_config": {
          "cumulus_message": {
            "outputs": [
              {
                "source": "{$}",
                "destination": "{$.payload}"
              },
              {
                "source": "{$.output.anykey}",
                "destination": "{$.meta.baz}"
              }
            ]
          }
        }
      }
    }
  }
}

The corresponding Cumulus Message would be:

    {
      "task_config": {
        "cumulus_message": {
          "outputs": [
            {
              "source": "{$}",
              "destination": "{$.payload}"
            },
            {
              "source": "{$.output.anykey}",
              "destination": "{$.meta.baz}"
            }
          ]
        }
      },
      "meta": {
        "foo": "bar"
      },
      "payload": {
        "anykey": "anyvalue"
      }
    }

Given the response from the task is:

    {
      "output": {
          "anykey": "boo"
      }
    }

The Cumulus Message Adapter would output the following Cumulus Message:

    {
      "task_config": {
          "cumulus_message": {
            "outputs": [
              {
                "source": "{$}",
                "destination": "{$.payload}"
              },
              {
                "source": "{$.output.anykey}",
                "destination": "{$.meta.baz}"
              }
            ]
          }
      },
      "meta": {
        "foo": "bar",
        "baz": "boo"
      },
      "payload": {
        "output": {
          "anykey": "boo"
        }
      }
    }

6. Apply Remote Message Configuration​

If the ReplaceConfig configuration parameter is defined, the CMA will evaluate the configuration options provided, and if required write a portion of the Cumulus Message to S3, and add a replace key to the message for future steps to utilize.

note

The non user-modifiable field cumulus-meta will always be retained, regardless of the configuration.

For example, if the output message (post output configuration) from a cumulus message looks like:

    {
      "cumulus_meta": {
        "some_key": "some_value"
      },
      "ReplaceConfig": {
        "FullMessage": true
      },
      "task_config": {
        "cumulus_message": {
          "outputs": [
            {
              "source": "{$}",
              "destination": "{$.payload}"
            },
            {
              "source": "{$.output.anykey}",
              "destination": "{$.meta.baz}"
            }
          ]
        }
      },
      "meta": {
        "foo": "bar",
        "baz": "boo"
      },
      "payload": {
        "output": {
          "anykey": "boo"
        }
      }
    }

the resultant output would look like:

{
  "cumulus_meta": {
    "some_key": "some_value"
  },
  "replace": {
    "TargetPath": "$",
    "Bucket": "some-internal-bucket",
    "Key": "events/some-event-id"
  }
}

Additional features​

Validate task input, output and configuration messages against the schemas provided​

The Cumulus Message Adapter has the capability to validate task input, output and configuration messages against their schemas. The default location of the schemas is the schemas folder in the top level of the task and the default filenames are input.json, output.json, and config.json. The task can also configure a different schema location. If no schema can be found, the Cumulus Message Adapter will not validate the messages.

Last updated on by Juanisa McCoy