diff --git a/docs/access-control-and-security/applications.md b/docs/access-control-and-security/applications.md index 2c4b637b..fc78c737 100644 --- a/docs/access-control-and-security/applications.md +++ b/docs/access-control-and-security/applications.md @@ -15,8 +15,8 @@ Each application can generate one or more sets of keys and secrets, and these pa ### Configuring Application​ To create a new application, -1. From the left menu navigation, navigate to **ACCESS CONTROL > Applications**. -2. Click **Create Application** and provide an app name. +1. From the left menu navigation, navigate to **Access Control > Applications**. +2. Click **Create application** and provide an app name. 3. Once your application is created, click the edit button next to its name. @@ -26,7 +26,7 @@ The following roles can be granted to the application. * **Application API**: Create and manage applications. ### Generating Access Keys​ -Once your application's permission levels are chosen, access must be granted to the application. This is done by generating an Access Key. Click **Create Access Key** to generate a unique **Key Id** and **Key Secret**. These values are shown only once, so ensure to copy the credentials and store them privately. +Once your application's permission levels are chosen, access must be granted to the application. This is done by generating an Access Key. Click **Create access key** to generate a unique **Key Id** and **Key Secret**. These values are shown only once, so ensure to copy the credentials and store them privately. Once a key has been created, you can perform two actions on the key: @@ -38,7 +38,7 @@ Once a key has been created, you can perform two actions on the key: ### Adding Permissions​ In this section, you can provide the application with access to workflows, tasks, secrets, or tags. To add the permissions, 1. Click **+Add Permission** from the **Workflow and Task Permissions** section. -2. Choose the required Workflow/Task/Secret/Tag/Domain in the pop-up window. +2. Choose the required Workflow/Task/Secret/Tag/Domain/Integration/Prompt in the pop-up window. diff --git a/docs/access-control-and-security/tags.md b/docs/access-control-and-security/tags.md index e5870536..801c9a73 100644 --- a/docs/access-control-and-security/tags.md +++ b/docs/access-control-and-security/tags.md @@ -7,7 +7,7 @@ You can either add tags directly to individual workflows/tasks/secrets/scheduler ## Adding Tags to Workflow​s​ To add a tag to a workflow, -1. From the left menu, navigate to **WORKFLOWS > Definitions** and find the workflow you wish to tag. +1. From the left menu, navigate to **Definitions > Workflow** and find the workflow you wish to tag. 2. In the **Actions** column, click the tag icon.

Adding a tag to an already created workflow

@@ -19,15 +19,17 @@ This will open a pop-up window that allows you to add a new tag. Type a tag name ## Adding Tags to Task​s​ To add a tag to a task, -1. From the left menu, navigate to the **TASKS > Definitions** and find the task you wish to tag. +1. From the left menu, navigate to the **Definitions > Task** and find the task you wish to tag. 2. In the **Actions** column, click the tag icon. +

Adding a tag to an already created task

+ This will open a pop-up window that allows you to add a new tag. Type a tag name in the format **key:value** and press enter to create new tags. You may also remove tags from the same window by clicking the "X" next to the tag you wish to delete. ## Adding Tags to Scheduler​ To add a tag to a scheduler, -1. From the left menu, navigate to **SCHEDULER > Definitions** and find the scheduler you wish to tag. +1. From the left menu, navigate to **Definitions > Scheduler** and find the scheduler you wish to tag. 2. In the **Actions** column, click the tag icon. This will open a pop-up window that allows you to add a new tag. Type a tag name in the format **key:value** and press enter to create new tags. You may also remove tags from the same window by clicking the "X" next to the tag you wish to delete. @@ -35,7 +37,7 @@ This will open a pop-up window that allows you to add a new tag. Type a tag name ## Adding Tags to Secrets​ To add a tag to a secret, -1. From the left menu, navigate to **Secrets** and find the secret you wish to tag. +1. From the left menu, navigate to **Definitions > Secrets** and find the secret you wish to tag. 2. In the **Actions** column, click the tag icon. This will open a pop-up window that allows you to add a new tag. Type a tag name in the format **key:value** and press enter to create new tags. You may also remove tags from the same window by clicking the "X" next to the tag you wish to delete. @@ -50,8 +52,8 @@ Suppose you have a group of users from the accounts team and want to share the w To add permissions to the group, 1. Ensure that the workflow is tagged with the tag **team:accounts**. (If permission is to be shared for tasks/secrets, you need to add the tags to the corresponding items.) -2. Navigate to **ACCESS CONTROL > Groups** and click the edit icon near your group name. -3. From the **Workflow and Task Permissions** section, click **+Add Permission**. +2. Navigate to **Access Control > Groups** and click the edit icon near your group name. +3. From the **Permissions** section, click **+Add Permission**. 4. Click on the **Tag** section, choose **team:accounts** tag, and provide EXECUTE permission. You must also provide READ permission to list the workflows/tasks/schedulers/secrets in your Conductor console. 5. Clicking **Add Permission** adds the tag to the Group. @@ -66,7 +68,7 @@ You can also allow the applications created to have explicit permissions over th Suppose you want to provide access to the tag “**team:accounts**” for your application; 1. Ensure that the workflow/task/secret/scheduler is tagged with the tag **team:accounts**. -2. Then, navigate to **ACCESS CONTROL > Applications** and click the edit icon near your app name. +2. Then, navigate to **Access Control > Applications** and click the edit icon near your app name. 3. From the **Workflow and Task Permissions** section, click **+Add Permission**. 4. Click on the **Tag** section, choose **team:accounts** tag, and provide the required permission. 5. Clicking **Add Permission** adds the tag to the application. diff --git a/docs/access-control-and-security/users-and-groups.md b/docs/access-control-and-security/users-and-groups.md index 5f967581..9feb273b 100644 --- a/docs/access-control-and-security/users-and-groups.md +++ b/docs/access-control-and-security/users-and-groups.md @@ -12,10 +12,10 @@ This feature is available only to the Admins of an Orkes Conductor instance. To invite a user to your Orkes Cloud instance, -1. From your Conductor server, navigate to **ACCESS CONTROL > Users** from the left menu. +1. From your Conductor server, navigate to **Access Control > Users** from the left menu. 2. Click the **Create User** button. -3. You need to fill in the following user details: -4. Click **Create**, and an email invitation will be sent to the user with the instructions to access the Conductor instance. +3. You need to fill in the following user details: +4. Click **Save**, and the user can now access the Conductor instance. ### User Roles​​ @@ -29,7 +29,7 @@ A user can have the following roles: ### Editing Users​ -To change the access for a specific user, click on the edit button next to the user, and change the role by clicking the toggle button for the relevant roles. +To change the permission for a specific user, click on the edit button next to the user, and update with the required permissions.

Editing user roles in Conductor

@@ -41,23 +41,22 @@ Groups are a way to share workflows and tasks among your team quickly. ### Creating Groups​​ To create a user group: -1. From the left menu, navigate to **ACCESS CONTROL > Groups**. -2. Click **Create Group** and provide the following details: -3. Click **Create**. +1. From the left menu, navigate to **Access Control > Groups**. +2. Click **Create Group** and provide the following details: +3. Click **Save**.

Creating Groups in Conductor

-4. Once the group is created, you can assign a role to the group. The Group can take the roles *Admin*, *User*, *Metadata Manager*, *Workflow Manager* or *Read Only User*. -5. You can add members by clicking **+Add User** from the **Members** section. You can add only the users that have already been created/invited. If the user you are looking for has not been added, you can invite and then add them to the groups. +4. You can add members by clicking **+Add User** from the **Members** section. You can add only the users that have already been created/invited. If the user you are looking for has not been added, you can invite and then add them to the groups. -**Workflow and Tasks Permissions** is an additional section where you can limit the group members' access to the permitted workflows, tasks, secrets & tags. +**Permissions** is an additional section where you can limit the group members' access to the permitted workflows, tasks, secrets, tags, domains, integrations & prompts. -6. Click **+Add Permission**, and you can choose the group to have access to selected Workflows/Tasks/Secrets/Tags/Domains. Permissions that can be granted include Read, Create, Update, Execute & Delete. +6. Click **+Add Permission**, and you can choose the group to have access to selected Workflows/Tasks/Secrets/Tags/Domains/Integrations/Prompts. Permissions that can be granted include Read, Create, Update, Execute & Delete.

Granting access to specific tasks and workflows

:::note -Even if certain permissions are granted under the **Workflow and Tasks Permissions** section, the chosen role supersedes these permissions. This means that if both the **Workflow and Tasks Permissions** section is configured and a role is selected, the role always supersedes the other. +Even if certain permissions are granted under the **Permissions** section, the chosen role supersedes these permissions. This means that if both the **Permissions** section is configured and a role is selected, the role always supersedes the other. ::: ### Group Roles​ diff --git a/docs/developer-guides/debugging-workflows.md b/docs/developer-guides/debugging-workflows.md index 4f798ad9..6592f44c 100644 --- a/docs/developer-guides/debugging-workflows.md +++ b/docs/developer-guides/debugging-workflows.md @@ -9,7 +9,7 @@ Orkes Conductor provides a visual representation of workflows that aids in quick ## Searching/Viewing Workflow Executions -All recent workflow executions are listed on the **WORKFLOWS > Executions** page. This view is filtered by the permissions of the user by default, i.e., users can view the execution of only the permitted workflows. +All recent workflow executions are listed on the **Executions > Workflow** page. This view is filtered by the permissions of the user by default, i.e., users can view the execution of only the permitted workflows.

Workflow Executions page

diff --git a/docs/developer-guides/metrics-and-observability.md b/docs/developer-guides/metrics-and-observability.md index 73d91ca6..20c55b97 100644 --- a/docs/developer-guides/metrics-and-observability.md +++ b/docs/developer-guides/metrics-and-observability.md @@ -11,7 +11,7 @@ Orkes Conductor uses the popular platform Prometheus for recording a rich set of In this document, we’ve included a sample dashboard set using Prometheus & Grafana. -1. To access your dashboard, navigate to **Metrics & Alerts** from your Conductor console. If you cannot see the “Metrics & Alerts” option on your Conductor console, [please reach out to our team](https://app.slack.com/client/T02KG20GJ1Z/C02KJ820XPW). +1. To access your dashboard, navigate to **Metrics** from your Conductor console. If you cannot see this option on your Conductor console, [please reach out to our team](https://app.slack.com/client/T02KG20GJ1Z/C02KJ820XPW).

Accessing dashboard from Conductor Console

diff --git a/docs/developer-guides/monitoring-task-queues.md b/docs/developer-guides/monitoring-task-queues.md index c8ea5adb..4f08e56c 100644 --- a/docs/developer-guides/monitoring-task-queues.md +++ b/docs/developer-guides/monitoring-task-queues.md @@ -4,7 +4,7 @@ The task queues are the collection of tasks waiting to be executed. It is useful ## Viewing Task Queues -You can monitor your task queues by navigating to **Tasks > Queue Monitor**. +You can monitor your task queues by navigating to **Executions > Queue Monitor**.

Monitoring Task Queues in Conductor

diff --git a/docs/developer-guides/scheduling-workflows.md b/docs/developer-guides/scheduling-workflows.md index 1035d6fb..be7b4d07 100644 --- a/docs/developer-guides/scheduling-workflows.md +++ b/docs/developer-guides/scheduling-workflows.md @@ -25,23 +25,23 @@ Examples could be: For creating a schedule, -1. From your Conductor server, navigate to **SCHEDULER** > **Definitions**. This page displays a list of all the defined schedules. +1. From your Conductor server, navigate to **Definitions > Scheduler**. This page displays a list of all the defined schedules. 2. Click the **Define Schedule** button in the top right corner. The following parameters can be used to configure the schedule: | Attribute | Description | | ------------------------------------- | ------------------------------------ | -| Schedule Name | Unique name for the schedule. Ensure that the schedule name contains no spaces or special characters. | +| Name | Unique name for the schedule. Ensure that the schedule name contains no spaces or special characters. | | Cron Expression | The cron expression is the schedule that the workflow will run on. You can either input the cron expression or choose from the available templates. See the section [Cron Expression](/content/developer-guides/scheduling-workflows#cron-expression) below for detailed information regarding this. | -| Workflow Name | Name of the workflow to be run. The author of the scheduler should have execution permission for the workflow.| -| Workflow Version | Selected Workflow may have different versions. Choose the version to be used in this schedule. If left blank, the latest version would be run. | -| Input Parameters | Provide fixed input values for the workflow as a JSON object. This field is optional. | -| Correlation Id | User-supplied ID to correlate or search the scheduled workflows. | -| Schedule Start | Choose the date & time for the scheduler to start running. It should be in the format **yyyy-mm-dd hh:mm (a/p)m**. This field is optional. | -| Schedule End | Choose the date & time for the scheduler to stop running. It should be in the format **yyyy-mm-dd hh:mm (a/p)m**. This field is optional. | -| Task to Domain Mapping | You can use the task to domain mapping to limit the workflow execution to specific domains. This field is optional. | -| Start Schedule Paused? | If selected, the schedule will be paused (so it will not run) upon creation. It is helpful when you don’t want to run the workflow scheduler, such as during maintenance. To resume the scheduled executions, this needs to be unpaused. | +| Workflow name | Name of the workflow to be run. The author of the scheduler should have execution permission for the workflow.| +| Workflow version | Selected Workflow may have different versions. Choose the version to be used in this schedule. If left blank, the latest version would be run. | +| Input params | Provide fixed input values for the workflow as a JSON object. This field is optional. | +| Correlation id | User-supplied ID to correlate or search the scheduled workflows. | +| Schedule start | Choose the date & time for the scheduler to start running. It should be in the format **yyyy-mm-dd hh:mm (a/p)m**. This field is optional. | +| Schedule end | Choose the date & time for the scheduler to stop running. It should be in the format **yyyy-mm-dd hh:mm (a/p)m**. This field is optional. | +| Task to domain mapping | You can use the task to domain mapping to limit the workflow execution to specific domains. This field is optional. | +| Start schedule paused? | If selected, the schedule will be paused (so it will not run) upon creation. It is helpful when you don’t want to run the workflow scheduler, such as during maintenance. To resume the scheduled executions, this needs to be unpaused. | 3. Click **Save Schedule**. @@ -105,7 +105,7 @@ Macros are also supported when setting a schedule. ## Viewing Executions -Once the schedulers are defined, you can view the executions from the **Scheduler > Executions** page. +Once the schedulers are defined, you can view the executions from the **Executions > Scheduler** page.

Scheduler Executions View

diff --git a/docs/developer-guides/secrets-in-conductor.md b/docs/developer-guides/secrets-in-conductor.md index e515867a..22455d02 100644 --- a/docs/developer-guides/secrets-in-conductor.md +++ b/docs/developer-guides/secrets-in-conductor.md @@ -10,7 +10,7 @@ used to hide these sensitive values on the UI. These values include usernames, p Follow the below steps to create and store secrets in Conductor: -1. From your Orkes Conductor Console, navigate to the **Secrets** option from the left menu. The *Secrets* page lists all the secrets associated with your account that you have access to. +1. From your Orkes Conductor Console, navigate to the **Definitions > Secrets** option from the left menu. The *Secrets* page lists all the secrets associated with your account that you have access to. 2. Click **Add Secrets** and provide the following values: 3. Clicking **Add** saves the secret. @@ -25,13 +25,13 @@ We can manage secrets using the following ways. In each of these methods, the pr ### Using UI -Users with access to the secret can update the secret on the UI. Access the left menu "Secrets". +Users with access to the secret can update the secret on the UI. Access the left menu "Definitions > Secrets". ### Using APIs The following API endpoints can be invoked with credentials that have permission to update the secret value. -### Using a Worker +#### Using a Worker A common use case is when a secret managed by Conductor is an access token with an expiry. Tokens that expire require a periodic refresh, and this can be easily achieved using a system worker task that can update the secret. This system worker does the same function as a custom worker updating a secret. diff --git a/docs/developer-guides/workflow-version-behavior-on-execution.md b/docs/developer-guides/workflow-version-behavior-on-execution.md index b800e348..20be0c15 100644 --- a/docs/developer-guides/workflow-version-behavior-on-execution.md +++ b/docs/developer-guides/workflow-version-behavior-on-execution.md @@ -39,6 +39,10 @@ Any changes to the definition won’t impact if the execution is already running In this case, to be consistent with your business flow, you can leverage the [skip task API](https://orkes.io/content/reference-docs/api/workflow/skip-task-from-workflow) to skip the task execution that was already completed. +### API Method + +You can use the [workflow upgrade API](/content/reference-docs/api/workflow/upgrade-workflow) to upgrade the running workflow to another version. + ### SDKs #### C# diff --git a/static/img/accessing-dashboard.png b/static/img/accessing-dashboard.png index fc90df0f..9556a8e2 100644 Binary files a/static/img/accessing-dashboard.png and b/static/img/accessing-dashboard.png differ diff --git a/static/img/adding-permissions-for-applications.png b/static/img/adding-permissions-for-applications.png index 6cd0f38a..b3fcd753 100644 Binary files a/static/img/adding-permissions-for-applications.png and b/static/img/adding-permissions-for-applications.png differ diff --git a/static/img/adding-tag-to-task.png b/static/img/adding-tag-to-task.png new file mode 100644 index 00000000..f63b2a91 Binary files /dev/null and b/static/img/adding-tag-to-task.png differ diff --git a/static/img/adding-tags-to-a-user-group-in-conductor.png b/static/img/adding-tags-to-a-user-group-in-conductor.png index 8327b450..b99266a2 100644 Binary files a/static/img/adding-tags-to-a-user-group-in-conductor.png and b/static/img/adding-tags-to-a-user-group-in-conductor.png differ diff --git a/static/img/adding-tags-to-application-in-orkes-conductor.png b/static/img/adding-tags-to-application-in-orkes-conductor.png index 85247495..6ebe316b 100644 Binary files a/static/img/adding-tags-to-application-in-orkes-conductor.png and b/static/img/adding-tags-to-application-in-orkes-conductor.png differ diff --git a/static/img/adding-tags-to-workflow.png b/static/img/adding-tags-to-workflow.png index 48c27ae4..407f1355 100644 Binary files a/static/img/adding-tags-to-workflow.png and b/static/img/adding-tags-to-workflow.png differ diff --git a/static/img/creating-groups.png b/static/img/creating-groups.png index 00475ba6..915eb5e2 100644 Binary files a/static/img/creating-groups.png and b/static/img/creating-groups.png differ diff --git a/static/img/edit-user-roles.png b/static/img/edit-user-roles.png index 3283a56e..037fb68b 100644 Binary files a/static/img/edit-user-roles.png and b/static/img/edit-user-roles.png differ diff --git a/static/img/editing-tags-in-conductor.png b/static/img/editing-tags-in-conductor.png index f56216d4..07aee805 100644 Binary files a/static/img/editing-tags-in-conductor.png and b/static/img/editing-tags-in-conductor.png differ diff --git a/static/img/scheduler-executions.jpg b/static/img/scheduler-executions.jpg index 0f2c0ddf..5b5cef96 100644 Binary files a/static/img/scheduler-executions.jpg and b/static/img/scheduler-executions.jpg differ diff --git a/static/img/step-1-terminate-workflow.png b/static/img/step-1-terminate-workflow.png index 9761901e..598ac57c 100644 Binary files a/static/img/step-1-terminate-workflow.png and b/static/img/step-1-terminate-workflow.png differ diff --git a/static/img/step-2-restart-with-latest-definitions.png b/static/img/step-2-restart-with-latest-definitions.png index ffcf4547..30661625 100644 Binary files a/static/img/step-2-restart-with-latest-definitions.png and b/static/img/step-2-restart-with-latest-definitions.png differ diff --git a/static/img/task-queue-monitor-view.png b/static/img/task-queue-monitor-view.png index 1971fb42..4197e0fc 100644 Binary files a/static/img/task-queue-monitor-view.png and b/static/img/task-queue-monitor-view.png differ diff --git a/static/img/task-to-domain.png b/static/img/task-to-domain.png index b6e2597b..3fd63c12 100644 Binary files a/static/img/task-to-domain.png and b/static/img/task-to-domain.png differ diff --git a/static/img/workflow-executions.png b/static/img/workflow-executions.png index 77a2f718..177af283 100644 Binary files a/static/img/workflow-executions.png and b/static/img/workflow-executions.png differ