From 9ffe0352ce40fd883e69ec299dac99e3e19105fe Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Bianchi Date: Fri, 10 Jan 2025 11:57:29 +0100 Subject: [PATCH 1/3] Recommend container naming convention for runtime implementations - Added a note in the DSL reference specifying a recommended naming convention for container tasks in runtime implementations. Closes #1055 Signed-off-by: Jean-Baptiste Bianchi --- dsl-reference.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/dsl-reference.md b/dsl-reference.md index ac9e1261..572c8d32 100644 --- a/dsl-reference.md +++ b/dsl-reference.md @@ -817,6 +817,12 @@ do: image: fake-image ``` +> [!NOTE] +> When a `container process` is executed, it is recommended that runtime implementations follow a predictable naming convention for the container name. This can improve monitoring, logging, and container lifecycle management. +> +> We recommand using the following convention: `{workflow.name}-{uuid}.{workflow.namespace}-{task.name}` + + ##### Script Process Enables the execution of custom scripts or code within a workflow, empowering workflows to perform specialized logic, data processing, or integration tasks by executing user-defined scripts written in various programming languages. From 07143cced6eba0a191f99b1f51c656d74acb06ac Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Bianchi Date: Fri, 10 Jan 2025 13:10:22 +0100 Subject: [PATCH 2/3] Update dsl-reference.md Signed-off-by: Jean-Baptiste Bianchi Co-authored-by: Charles d'Avernas --- dsl-reference.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/dsl-reference.md b/dsl-reference.md index 572c8d32..b3ec2e38 100644 --- a/dsl-reference.md +++ b/dsl-reference.md @@ -820,7 +820,7 @@ do: > [!NOTE] > When a `container process` is executed, it is recommended that runtime implementations follow a predictable naming convention for the container name. This can improve monitoring, logging, and container lifecycle management. > -> We recommand using the following convention: `{workflow.name}-{uuid}.{workflow.namespace}-{task.name}` +The ServerlessWorkflow specification recommends using the following convention: `{workflow.name}-{uuid}.{workflow.namespace}-{task.name}` ##### Script Process From e17a44dda1704d8918dadeb972c7a12c09bf4a58 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Bianchi Date: Fri, 10 Jan 2025 16:15:23 +0100 Subject: [PATCH 3/3] Updated dsl-reference.md - See comment https://github.com/serverlessworkflow/specification/pull/1061#pullrequestreview-2542670989 Signed-off-by: Jean-Baptiste Bianchi --- dsl-reference.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/dsl-reference.md b/dsl-reference.md index b3ec2e38..78d573bf 100644 --- a/dsl-reference.md +++ b/dsl-reference.md @@ -818,10 +818,9 @@ do: ``` > [!NOTE] -> When a `container process` is executed, it is recommended that runtime implementations follow a predictable naming convention for the container name. This can improve monitoring, logging, and container lifecycle management. +> When a `container process` is executed, runtime implementations are recommended to follow a predictable naming convention for the container name. This can improve monitoring, logging, and container lifecycle management. > -The ServerlessWorkflow specification recommends using the following convention: `{workflow.name}-{uuid}.{workflow.namespace}-{task.name}` - +> The Serverless Workflow specification recommends using the following convention: `{workflow.name}-{uuid}.{workflow.namespace}-{task.name}` ##### Script Process