From 51cb609084a75bc84bc58722d0dfec278f7e46bc Mon Sep 17 00:00:00 2001 From: RizaFarheen Date: Wed, 13 Nov 2024 12:24:30 +0400 Subject: [PATCH 1/3] Update taskdef.md --- docs/documentation/configuration/taskdef.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/documentation/configuration/taskdef.md b/docs/documentation/configuration/taskdef.md index 499c49b58..c209a0d8e 100644 --- a/docs/documentation/configuration/taskdef.md +++ b/docs/documentation/configuration/taskdef.md @@ -15,7 +15,7 @@ This should not be confused with [*Task Configurations*](./workflowdef/index.md# | retryLogic | string (enum) | Mechanism for the retries | See [Retry Logic](#retry-logic) | | retryDelaySeconds | number | Time to wait before retries | Defaults to 60 seconds | | timeoutPolicy | string (enum) | Task's timeout policy | Defaults to `TIME_OUT_WF`; See [Timeout Policy](#timeout-policy) | -| timeoutSeconds | number | Time in seconds, after which the task is marked as `TIMED_OUT` if not completed after transitioning to `IN_PROGRESS` status for the first time | No timeouts if set to 0 | +| timeoutSeconds | number | Time in seconds, after which the task is marked as `TIMED_OUT` if it has not reached a terminal state after transitioning to `IN_PROGRESS` status for the first time | No timeouts if set to 0 | | responseTimeoutSeconds | number | If greater than 0, the task is rescheduled if not updated with a status after this time (heartbeat mechanism). Useful when the worker polls for the task but fails to complete due to errors/network failure. | Defaults to 3600 | | pollTimeoutSeconds | number | Time in seconds, after which the task is marked as `TIMED_OUT` if not polled by a worker | No timeouts if set to 0 | | inputKeys | array of string(s) | Array of keys of task's expected input. Used for documenting task's input. | Optional. See [Using inputKeys and outputKeys](#using-inputkeys-and-outputkeys). | @@ -57,7 +57,7 @@ You have 1000 task executions waiting in the queue, and 1000 workers polling thi **Example** Let's set `rateLimitFrequencyInSeconds = 5`, and `rateLimitPerFrequency = 12`. This means our frequency window is of 5 seconds duration, and for each frequency window, Conductor would only give 12 tasks to workers. So, in a given minute, Conductor would only give 12*(60/5) = 144 tasks to workers irrespective of the number of workers that are polling for the task. -Note that unlike `concurrentExecLimit`, rate limiting doesn't take into account tasks already in progress/completed. Even if all the previous tasks are executed within 1 sec, or would take a few days, the new tasks are still given to workers at configured frequency, 144 tasks per minute in above example. +Note that unlike `concurrentExecLimit`, rate limiting doesn't take into account tasks already in progress or a terminal state. Even if all the previous tasks are executed within 1 sec, or would take a few days, the new tasks are still given to workers at configured frequency, 144 tasks per minute in above example. ### Using `inputKeys` and `outputKeys` From bf6a3792322a11d197cd8e361164e97373dbbd59 Mon Sep 17 00:00:00 2001 From: RizaFarheen Date: Wed, 13 Nov 2024 12:28:15 +0400 Subject: [PATCH 2/3] Update taskdef.md --- docs/documentation/configuration/taskdef.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/documentation/configuration/taskdef.md b/docs/documentation/configuration/taskdef.md index c209a0d8e..2d326f081 100644 --- a/docs/documentation/configuration/taskdef.md +++ b/docs/documentation/configuration/taskdef.md @@ -10,21 +10,21 @@ This should not be confused with [*Task Configurations*](./workflowdef/index.md# | Field | Type | Description | Notes | | :-------------------------- | :----------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :------------------------------------------------------------------------------- | | name | string | Task Name. Unique name of the Task that resonates with its function. | Must be unique | -| description | string | Description of the task | Optional | -| retryCount | number | Number of retries to attempt when a Task is marked as failure | Defaults to 3 with maximum allowed capped at 10 | -| retryLogic | string (enum) | Mechanism for the retries | See [Retry Logic](#retry-logic) | -| retryDelaySeconds | number | Time to wait before retries | Defaults to 60 seconds | -| timeoutPolicy | string (enum) | Task's timeout policy | Defaults to `TIME_OUT_WF`; See [Timeout Policy](#timeout-policy) | -| timeoutSeconds | number | Time in seconds, after which the task is marked as `TIMED_OUT` if it has not reached a terminal state after transitioning to `IN_PROGRESS` status for the first time | No timeouts if set to 0 | +| description | string | Description of the task. | Optional | +| retryCount | number | Number of retries to attempt when a Task is marked as failure. | Defaults to 3 with maximum allowed capped at 10 | +| retryLogic | string (enum) | Mechanism for the retries. | See [Retry Logic](#retry-logic) | +| retryDelaySeconds | number | Time to wait before retries. | Defaults to 60 seconds | +| timeoutPolicy | string (enum) | Task's timeout policy. | Defaults to `TIME_OUT_WF`; See [Timeout Policy](#timeout-policy) | +| timeoutSeconds | number | Time in seconds, after which the task is marked as `TIMED_OUT` if it has not reached a terminal state after transitioning to `IN_PROGRESS` status for the first time. | No timeouts if set to 0 | | responseTimeoutSeconds | number | If greater than 0, the task is rescheduled if not updated with a status after this time (heartbeat mechanism). Useful when the worker polls for the task but fails to complete due to errors/network failure. | Defaults to 3600 | -| pollTimeoutSeconds | number | Time in seconds, after which the task is marked as `TIMED_OUT` if not polled by a worker | No timeouts if set to 0 | +| pollTimeoutSeconds | number | Time in seconds, after which the task is marked as `TIMED_OUT` if not polled by a worker. | No timeouts if set to 0 | | inputKeys | array of string(s) | Array of keys of task's expected input. Used for documenting task's input. | Optional. See [Using inputKeys and outputKeys](#using-inputkeys-and-outputkeys). | | outputKeys | array of string(s) | Array of keys of task's expected output. Used for documenting task's output. | Optional. See [Using inputKeys and outputKeys](#using-inputkeys-and-outputkeys). | | inputTemplate | object | Define default input values. | Optional. See [Using inputTemplate](#using-inputtemplate) | -| concurrentExecLimit | number | Number of tasks that can be executed at any given time | Optional | +| concurrentExecLimit | number | Number of tasks that can be executed at any given time. | Optional | | rateLimitFrequencyInSeconds | number | Sets the rate limit frequency window. | Optional. See [Task Rate limits](#task-rate-limits) | | rateLimitPerFrequency | number | Sets the max number of tasks that can be given to workers within window. | Optional. See [Task Rate limits](#task-rate-limits) below | -| ownerEmail | string | Email address of the team that owns the task | Required | +| ownerEmail | string | Email address of the team that owns the task. | Required | ### Retry Logic @@ -63,7 +63,7 @@ Note that unlike `concurrentExecLimit`, rate limiting doesn't take into account ### Using `inputKeys` and `outputKeys` * `inputKeys` and `outputKeys` can be considered as parameters and return values for the Task. -* Consider the task Definition as being represented by an interface: ```(value1, value2 .. valueN) someTaskDefinition(key1, key2 .. keyN);``` +* Consider the task Definition as being represented by an interface: ```(value1, value2 .. valueN) someTaskDefinition(key1, key2 .. keyN);```. * However, these parameters are not strictly enforced at the moment. Both `inputKeys` and `outputKeys` act as a documentation for task re-use. The tasks in workflow need not define all of the keys in the task definition. * In the future, this can be extended to be a strict template that all task implementations must adhere to, just like interfaces in programming languages. From 301a05c179a1fcfd22c8744a50e42a710ee812b3 Mon Sep 17 00:00:00 2001 From: RizaFarheen Date: Mon, 25 Nov 2024 17:16:24 +0400 Subject: [PATCH 3/3] Updates - Slack URL updates --- CONTRIBUTING.md | 2 +- conductor-clients/java/conductor-java-sdk/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b102a7a37..d8b513010 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -13,7 +13,7 @@ I have a question! We have a dedicated [discussion forum](https://github.com/conductor-oss/conductor/discussions) for asking "how to" questions and to discuss ideas. The discussion forum is a great place to start if you're considering creating a feature request or work on a Pull Request. *Please do not create issues to ask questions.* -Conductor users hangout in the [Slack channel](https://join.slack.com/t/orkes-conductor/shared_invite/zt-xyxqyseb-YZ3hwwAgHJH97bsrYRnSZg). Join the channel for more real-time communication! +Conductor users hangout in the [Slack channel](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2vdbx239s-Eacdyqya9giNLHfrCavfaA). Join the channel for more real-time communication! I want to contribute! ------ diff --git a/conductor-clients/java/conductor-java-sdk/README.md b/conductor-clients/java/conductor-java-sdk/README.md index 024da8a8c..a6a18ceae 100644 --- a/conductor-clients/java/conductor-java-sdk/README.md +++ b/conductor-clients/java/conductor-java-sdk/README.md @@ -31,7 +31,7 @@ For insights into the Conductor project's future plans and upcoming features, ch We are building this based on feedback from our users and community. -We encourage everyone to share their thoughts and feedback! You can create new GitHub issues or comment on existing ones. You can also join our [Slack community](https://orkes-conductor.slack.com/) to connect with us. +We encourage everyone to share their thoughts and feedback! You can create new GitHub issues or comment on existing ones. You can also join our [Slack community](https://join.slack.com/t/orkes-conductor/shared_invite/zt-2vdbx239s-Eacdyqya9giNLHfrCavfaA) to connect with us. Thank you! ♥