Naming Executions

By default, Cumulus will assign a random name to workflow executions. If desired, though, a configurable prefix can be added to those execution names.

Naming executions triggered by rules

Rules now have an optional executionNamePrefix property. If set, any workflows triggered directly by that rule will have an execution name that starts with that prefix.

Naming executions enqueued by the QueueGranules and QueuePdrs tasks

The QueueGranules and QueuePdrs tasks add executions to a queue to be run later. These two tasks now support an optional config property called executionNamePrefix. If specified, any executions enqueued by those tasks will have an execution name that begins with that prefix. The value of that prefix should be configured in the workflow that contains the QueueGranules or QueuePdrs step.

In the following excerpt, the QueueGranules config.executionNamePrefix property is set using the value configured in the workflow's meta.executionNamePrefix.

Please note: This meta.executionNamePrefix property should not be confused with the optional rule executionNamePrefix property from the previous section. Setting executionNamePrefix as a root property of the rule will set a prefix for the names of any workflows triggered by the rule. Setting meta.executionNamePrefix on the rule will set meta.executionNamePrefix in the workflow messages generated for this rule, allowing workflow steps like QueueGranules to read from the message meta.executionNamePrefix for their config. Then, workflows scheduled by QueueGranules would use the configured execution name prefix.

Setting executionNamePrefix config for QueueGranules using rule.meta

If you wanted to use a prefix of "my-prefix", you would create a rule with a meta property similar to the following Rule snippet:

{
  ...other rule keys here...
  "meta":
    {
      "executionNamePrefix": "my-prefix"
    }
}

The value of meta.executionNamePrefix from the rule will be set as meta.executionNamePrefix in the workflow message.

Then, the workflow could contain a "QueueGranules" step with the following state, which uses meta.executionNamePrefix from the message as the value for the executionNamePrefix config to the "QueueGranules" step:

{
  "QueueGranules": {
    "Parameters": {
      "cma": {
        "event.$": "$",
        "ReplaceConfig": {
          "FullMessage": true
        },
        "task_config": {
          "queueUrl": "${start_sf_queue_url}",
          "provider": "{$.meta.provider}",
          "internalBucket": "{$.meta.buckets.internal.name}",
          "stackName": "{$.meta.stack}",
          "granuleIngestWorkflow": "${ingest_granule_workflow_name}",
          "executionNamePrefix": "{$.meta.executionNamePrefix}"
        }
      }
    },
    "Type": "Task",
    "Resource": "${queue_granules_task_arn}",
    "Retry": [
      {
        "ErrorEquals": [
          "Lambda.ServiceException",
          "Lambda.AWSLambdaException",
          "Lambda.SdkClientException"
        ],
        "IntervalSeconds": 2,
        "MaxAttempts": 6,
        "BackoffRate": 2
      }
    ],
    "Catch": [
      {
        "ErrorEquals": [
          "States.ALL"
        ],
        "ResultPath": "$.exception",
        "Next": "WorkflowFailed"
      }
    ],
    "End": true
  },
}