From 91e057e3353c6b0032fd6aacfffd138b8a50af5d Mon Sep 17 00:00:00 2001 From: RizaFarheen Date: Thu, 24 Oct 2024 16:53:44 +0400 Subject: [PATCH] Developer Edition updates --- .../quickstart-ai-orchestration.md | 20 +++++++++---------- docs/developer-guides/task-to-domain.md | 2 +- docs/developer-guides/using-workers.md | 2 +- docs/faqs/general-faqs.md | 2 +- docs/get-orkes-conductor.md | 2 +- .../adding-custom-code-worker.md | 10 +++++----- .../executing-tasks-in-parallel.md | 6 +++--- docs/getting-started/quickstart-1.md | 8 ++++---- docs/getting-started/quickstart-2.md | 6 +++--- docs/getting-started/quickstart-index.md | 2 +- docs/reference-docs/operators/get-workflow.md | 2 +- docs/reference-docs/operators/sub-workflow.md | 4 ++-- docs/reference-docs/operators/switch.md | 2 +- docs/reference-docs/system-tasks/http.md | 4 ++-- docs/sdks/authentication.md | 2 +- docs/sdks/golang.md | 4 ++-- docs/sdks/java.md | 4 ++-- docs/sdks/python.md | 6 +++--- ...rkes-data-and-triggering-opsgenie-alert.md | 4 ++-- ...endpoint-and-triggering-pagerduty-alert.md | 4 ++-- .../examples/api-processing-usps-example.md | 8 ++++---- .../custom-conductor-webhook-using-curl.md | 2 +- docs/templates/examples/document-approvals.md | 2 +- docs/templates/examples/finance.md | 2 +- ...eep-worker-running-until-condition-true.md | 2 +- .../examples/sequential-http-tasks.md | 4 ++-- docs/templates/image-effects.md | 7 ++----- docs/templates/video-processing-workflows.md | 13 +++++------- docs/templates/visual-image-search.md | 5 +---- 29 files changed, 66 insertions(+), 75 deletions(-) diff --git a/docs/developer-guides/quickstart-ai-orchestration.md b/docs/developer-guides/quickstart-ai-orchestration.md index ee9cf078..81a1eb0b 100644 --- a/docs/developer-guides/quickstart-ai-orchestration.md +++ b/docs/developer-guides/quickstart-ai-orchestration.md @@ -4,16 +4,16 @@ Orkes Conductor provides you the ability to build applications that leverage gen The example we will be using is to build a document classifier that identifies the type of document passed (e.g. a driver’s license, a W2 form, a mortgage application etc). The associated workflow in Conductor takes in as the input parameter a document file, checks that it is a pdf document, extracts the content from it, sends that information alongside a prompt to a LLM and obtains the classification result from the LLM. -This workflow is available as a [template in the Template Explorer](https://orkes.io/content/templates/document-classifier) in Orkes Conductor and in this guide we will be using the free Orkes Playground (you can use this example with your own Orkes Conductor cluster as well). +This workflow is available as a [template in the Template Explorer](https://orkes.io/content/templates/document-classifier) in Orkes Conductor and in this guide we will be using the Orkes Developer Edition (you can use this example with your own Orkes Conductor cluster as well). ## Command Line -1. Obtain a token from the Orkes Playground. - - Login to https://play.orkes.io/ - you can bookmark this URL for easy access. +1. Obtain a token from the Orkes Developer Edition. + - Login to https://developer.orkescloud.com/ - you can bookmark this URL for easy access. - Obtain the access token by clicking on the **Copy Token** link at the bottom of the left hand navigation. 2. Obtain an API key from Open AI by going [here](https://platform.openai.com/account/api-keys). 3. Setup Environment Variables. - - export CONDUCTOR_ACCESS_TOKEN=(The key you copied from Playground) + - export CONDUCTOR_ACCESS_TOKEN=(The key you copied from Developer Edition) - export OPEN_AI_KEY=(Your OPENAI API KEY) 4. Run the shell script below to create your document classifier application, execute it and view the output: @@ -27,9 +27,9 @@ curl -s https://raw.githubusercontent.com/orkes-io/orkes-templates/main/document ## Conductor UI -### Step 1: Login to Orkes Playground +### Step 1: Login to Orkes Developer Edition -1. Login to https://play.orkes.io/ - you can bookmark this URL for easy access. +1. Login to https://developer.orkescloud.com/ - you can bookmark this URL for easy access. ### Step 2: Create an LLM integration @@ -138,7 +138,7 @@ Important: Copy and store the secret in a safe location, as it is never displaye ```shell curl -s -X 'POST' \ - 'https://play.orkes.io/api/token' \ + 'https://developer.orkescloud.com/api/token' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ @@ -151,7 +151,7 @@ curl -s -X 'POST' \ ```shell curl -s -X 'POST' \ -'https://play.orkes.io/api/workflow/?priority=0' \ +'https://developer.orkescloud.com/api/workflow/?priority=0' \ -H 'accept: text/plain' \ -H 'X-Authorization: ' \ -H 'Content-Type: application/json' \ @@ -166,7 +166,7 @@ The command will return a workflow id. Note it down for use in the next step. ```shell curl -s -X 'GET' \ -'https://play.orkes.io/api/workflow//status?includeOutput=true&includeVariables=false' \ +'https://developer.orkescloud.com/api/workflow//status?includeOutput=true&includeVariables=false' \ -H 'accept: */*' \ -H 'X-Authorization: ' ``` @@ -181,5 +181,5 @@ You can pipe the output of above to the command below (requires [installing of j 4. You can view the execution visually by going to the Conductor UI and searching for it or directly via the URL below (make sure to replace the placeholder with your workflow execution id). ```json -https://play.orkes.io/execution/ +https://developer.orkescloud.com/execution/ ``` \ No newline at end of file diff --git a/docs/developer-guides/task-to-domain.md b/docs/developer-guides/task-to-domain.md index a2ab7e9c..265fa216 100644 --- a/docs/developer-guides/task-to-domain.md +++ b/docs/developer-guides/task-to-domain.md @@ -121,7 +121,7 @@ def startTaskRunnerWorkers(): key_id='key', key_secret='secret' ), - server_api_url='https://play.orkes.io/api', + server_api_url='https://developer.orkescloud.com/api', debug=True ) diff --git a/docs/developer-guides/using-workers.md b/docs/developer-guides/using-workers.md index 99400950..725291f3 100644 --- a/docs/developer-guides/using-workers.md +++ b/docs/developer-guides/using-workers.md @@ -188,7 +188,7 @@ In Orkes, an application account with a Worker role type enables workers to auth 1. Under Access Keys, select **Create access key** and store your credentials securely. 2. Set the Key ID and Key Secret in your environment variables. ``` bash - export CONDUCTOR_SERVER_URL= // eg: https://play.orkes.io/api + export CONDUCTOR_SERVER_URL= // eg: https://developer.orkescloud.com/api export CONDUCTOR_AUTH_KEY= export CONDUCTOR_AUTH_SECRET= ``` diff --git a/docs/faqs/general-faqs.md b/docs/faqs/general-faqs.md index 37a4f0fd..fc88501d 100644 --- a/docs/faqs/general-faqs.md +++ b/docs/faqs/general-faqs.md @@ -24,7 +24,7 @@ export const faqs = [ ### Is it possible to pull data from multiple endpoints simultaneously rather than sequentially? -Yes, it’s possible to pull data from multiple endpoints simultaneously. Have a look at this [workflow execution](https://play.orkes.io/execution/7f438f95-e907-11ed-b7d4-364566de507d). You can see that the parallel execution, which is the construct supported in Conductor, can run 10s of thousands of parallel executions. +Yes, it’s possible to pull data from multiple endpoints simultaneously, using [Fork/Join](https://orkes.io/content/reference-docs/operators/fork-join) task, which is the construct supported in Conductor, that can run 10s of thousands of parallel executions. ### Can we start a workflow not from the start but from any steps within the workflow? diff --git a/docs/get-orkes-conductor.md b/docs/get-orkes-conductor.md index 67061d56..f14fcc39 100644 --- a/docs/get-orkes-conductor.md +++ b/docs/get-orkes-conductor.md @@ -17,7 +17,7 @@ There are two hosting options: * Orkes-hosted - End-to-end hosting managed by Orkes. * Customer-hosted - Deploy within your own infrastructure (Azure, AWS, GCP, or private cloud). -You can try [Orkes Playground](https://play.orkes.io/?utm_campaign=set-up-orkes-conductor&utm_source=orkes-doc&utm_medium=web) for immediate testing. A [14-day free trial of Orkes Cloud](https://cloud.orkes.io/signupset-up-orkes-conductororkes-doc&utm_medium=web) is also available for setting up custom Conductor clusters. +You can try [Orkes Developer Edition](https://developer.orkescloud.com/?utm_campaign=set-up-orkes-conductor&utm_source=orkes-doc&utm_medium=web) for immediate testing. A [14-day free trial of Orkes Cloud](https://cloud.orkes.io/signupset-up-orkes-conductororkes-doc&utm_medium=web) is also available for setting up custom Conductor clusters. ## Orkes Conductor - Local Setup diff --git a/docs/getting-started/adding-custom-code-worker.md b/docs/getting-started/adding-custom-code-worker.md index d46cc3a0..e3413ecb 100644 --- a/docs/getting-started/adding-custom-code-worker.md +++ b/docs/getting-started/adding-custom-code-worker.md @@ -36,8 +36,8 @@ webkitallowfullscreen="webkitallowfullscreen"> -We can see that when we run this workflow for amounts >= $10,000, it runs a fraud check. If we named the task `fraud-check`, we'd notice that it is actually executed (in playground env), but how? -That's because there is a pre-defined task that is polling and running all the tasks named `fraud-check`. We also have the required permissions in the playground for this task. +We can see that when we run this workflow for amounts >= $10,000, it runs a fraud check. If we named the task `fraud-check`, we'd notice that it is actually executed (in Developer Edition env), but how? +That's because there is a pre-defined task that is polling and running all the tasks named `fraud-check`. We also have the required permissions in the Developer Edition for this task. So how can we implement this task for ourselves? First, let's rename the task to a new unique name for ourselves - for ex: `fraud-check-`. And now, let’s see how this custom fraud check can be implemented: @@ -67,7 +67,7 @@ from multiprocessing import set_start_method set_start_method("fork") ############################################# -SERVER_API_URL = 'https://play.orkes.io/api' +SERVER_API_URL = 'https://developer.orkescloud.com/api' KEY_ID = '' KEY_SECRET = '' @@ -187,13 +187,13 @@ with TaskHandler(workers, configuration, scan_for_annotated_workers=True) as tas -Once we have cloned the repo or copied the required elements to our local machines, we can run this locally by connecting to the playground server. +Once we have cloned the repo or copied the required elements to our local machines, we can run this locally by connecting to the Conductor server. To do this, we must give the required permissions to our application. Refer to this [video](https://www.youtube.com/watch?v=PY34TcVzof0) to add permission to execute the custom worker we just created above (`fraud-check-`). After providing the permissions, we can change the definition to run our worker (`fraud-check-`) and start the application. We can see that now our worker is picking up the task. -This is the **first example** of how a distributed worker is executed in Conductor; **without** exposing an endpoint or creating any sort of inbound connectivity, we were able to execute the task directly from our local machine pointing to the playground server. +This is the **first example** of how a distributed worker is executed in Conductor; **without** exposing an endpoint or creating any sort of inbound connectivity, we were able to execute the task directly from our local machine pointing to the Developer Edition server. :::tip Distributed workers in Conductor We can run similar workflows in production, too, workers could live in **any applications** or even **third-party services** and we can connect them all together using diff --git a/docs/getting-started/executing-tasks-in-parallel.md b/docs/getting-started/executing-tasks-in-parallel.md index 5f46a971..aaf9d664 100644 --- a/docs/getting-started/executing-tasks-in-parallel.md +++ b/docs/getting-started/executing-tasks-in-parallel.md @@ -41,15 +41,15 @@ webkitallowfullscreen="webkitallowfullscreen"> -If we named the task `retrieve-deposit-batch`, we'd notice that it is actually executed (in playground env), but how? -That's because there is a pre-defined task that is polling and running all the tasks named `retrieve-deposit-batch`. We also have the required permissions in the playground for this task. +If we named the task `retrieve-deposit-batch`, we'd notice that it is actually executed (in Developer Edition env), but how? +That's because there is a pre-defined task that is polling and running all the tasks named `retrieve-deposit-batch`. We also have the required permissions in the Developer Edition for this task. Here is the code reference for this worker: ```java dynamic https://github.com/conductor-sdk/orkes-java-springboot2-example/blob/main/src/main/java/io/orkes/example/banking/workers/ConductorWorkers.java section=2 .../workers/ConductorWorkers.java ``` -By default, it would return a random value between __5-10 tasks__. If we supply an input called __`batchCount`__ - we can retrieve up to 100 transactions. This is a limitation of the playground. In a dedicated +By default, it would return a random value between __5-10 tasks__. If we supply an input called __`batchCount`__ - we can retrieve up to 100 transactions. This is a limitation of the Developer Edition. In a dedicated cluster, you can run parallel tasks into the thousands or tens of thousands depending on the cluster's capacity. :::note Try out a larger batch diff --git a/docs/getting-started/quickstart-1.md b/docs/getting-started/quickstart-1.md index 9883e594..592e5aa6 100644 --- a/docs/getting-started/quickstart-1.md +++ b/docs/getting-started/quickstart-1.md @@ -57,7 +57,7 @@ from conductor.client.workflow.conductor_workflow import ConductorWorkflow from conductor.client.workflow.executor.workflow_executor import WorkflowExecutor configuration = Configuration( - server_api_url=SERVER_API_URL, // eg: https://play.orkes.io/api + server_api_url=SERVER_API_URL, // eg: https://developer.orkescloud.com/api debug=False, authentication_settings=AuthenticationSettings(key_id=KEY_ID, key_secret=KEY_SECRET) ) @@ -205,7 +205,7 @@ import { const clientPromise = orkesConductorClient({ keyId: "XXX", keySecret: "XXXX", - serverUrl: "SERVER_URL", // eg: https://play.orkes.io/api + serverUrl: "SERVER_URL", // eg: https://developer.orkescloud.com/api }); const client = await clientPromise; @@ -293,7 +293,7 @@ apiClient := client.NewAPIClient( SECRET, ), settings.NewHttpSettings( - "https://play.orkes.io/api", + "https://developer.orkescloud.com/api", )) // Create new workflow executor @@ -393,7 +393,7 @@ workflowId, err := executor.StartWorkflow(&model.StartWorkflowRequest{ Use the visual workflow editor in Orkes Platform to create your workflows. **To create a workflow:** -1. Log in to your Orkes cluster or the [Orkes Playground](https://play.orkes.io/). +1. Log in to your Orkes cluster or the [Orkes Developer Edition](https://developer.orkescloud.com/). 2. In the left navigation menu, go to **Definitions** > **Workflow**. 3. Select **(+) Define workflow**. 4. Enter a Name and Description for your workflow. diff --git a/docs/getting-started/quickstart-2.md b/docs/getting-started/quickstart-2.md index 2aa9d4ab..0aec8ae2 100644 --- a/docs/getting-started/quickstart-2.md +++ b/docs/getting-started/quickstart-2.md @@ -198,7 +198,7 @@ import { const clientPromise = orkesConductorClient({ keyId: "XXX", keySecret: "XXXX", - serverUrl: "SERVER_URL", // eg: https://play.orkes.io/api + serverUrl: "SERVER_URL", // eg: https://developer.orkescloud.com/api }); const client = await clientPromise; @@ -305,7 +305,7 @@ apiClient := client.NewAPIClient( SECRET, ), settings.NewHttpSettings( - "https://play.orkes.io/api", + "https://developer.orkescloud.com/api", )) taskRunner := worker.NewTaskRunnerWithApiClient(apiClient) @@ -493,7 +493,7 @@ Finally, your worker application requires programmatic access to the Conductor s 3. Generate the application access key and set the Key ID and Key Secret in your project environment variables. ``` -export CONDUCTOR_SERVER_URL= // eg: https://play.orkes.io/api +export CONDUCTOR_SERVER_URL= // eg: https://developer.orkescloud.com/api export CONDUCTOR_AUTH_KEY= export CONDUCTOR_AUTH_SECRET= ``` diff --git a/docs/getting-started/quickstart-index.md b/docs/getting-started/quickstart-index.md index e21d8a97..4051e4b2 100644 --- a/docs/getting-started/quickstart-index.md +++ b/docs/getting-started/quickstart-index.md @@ -198,7 +198,7 @@ Get the Conductor Clojure package from [clojars](https://clojars.org/io.orkes/co Once your development environment is set up, you need to configure your access to the Conductor server. In Orkes, programmatic access to Conductor is enabled by application-based access keys. To get authenticated, you must first create an application in Orkes Platform, then create an access key for your application. **To create an application:** -1. Log in to your Orkes cluster or the [Orkes Playground](https://play.orkes.io/). +1. Log in to your Orkes cluster or the [Orkes Developer Edition](https://developer.orkescloud.com/). 2. In the left navigation menu, go to **Access Control** > **Applications**. 3. Select **(+) Create application**. 4. Enter the application name, such as “myFirstWorkflow”. Use this application while following along with the quickstarts. diff --git a/docs/reference-docs/operators/get-workflow.md b/docs/reference-docs/operators/get-workflow.md index 1b87cb19..c14842ed 100644 --- a/docs/reference-docs/operators/get-workflow.md +++ b/docs/reference-docs/operators/get-workflow.md @@ -42,7 +42,7 @@ This is the task configuration for a Get Workflow task. ``` ## Task output -The Get Workflow task will return all the details of the retrieved workflow. View an example [here](https://play.orkes.io/execution/35d05a0f-0856-11ef-84f1-2e15deb1615b?tab=workflowInputOutput). +The Get Workflow task will return all the details of the retrieved workflow. ## Adding a Get Workflow task in UI **To add a Get Workflow task:** diff --git a/docs/reference-docs/operators/sub-workflow.md b/docs/reference-docs/operators/sub-workflow.md index 2fb96ca7..027234fb 100644 --- a/docs/reference-docs/operators/sub-workflow.md +++ b/docs/reference-docs/operators/sub-workflow.md @@ -96,8 +96,8 @@ You can add this as a sub-workflow in your required workflow whenever a payment

Payment workflow as sub-workflow in a subscription flow

This is a subscription workflow with multiple instances where payment flow is to be implemented. Here, the previously-created payment workflow is added as sub-workflows. -The above image is a simplified version of the subscription workflow. You can view the entire version in Playground -[here](https://play.orkes.io/workflowDef/Subscription/). +The above image is a simplified version of the subscription workflow. You can view the entire version in Developer Edition +[here](https://developer.orkescloud.com/workflowDef/Subscription/).

diff --git a/docs/reference-docs/operators/switch.md b/docs/reference-docs/operators/switch.md index c667ec00..b3a5f106 100644 --- a/docs/reference-docs/operators/switch.md +++ b/docs/reference-docs/operators/switch.md @@ -202,6 +202,6 @@ The script below returns `OLDER` or `NEWER` depending on whether the input date ))(); ``` -Check out the [sample workflow execution that runs this switch case](https://play.orkes.io/execution/9be8fb4d-e991-11ed-bb41-9e017806b678) in our Playground. +

diff --git a/docs/reference-docs/system-tasks/http.md b/docs/reference-docs/system-tasks/http.md index eb7495dd..0b89a868 100644 --- a/docs/reference-docs/system-tasks/http.md +++ b/docs/reference-docs/system-tasks/http.md @@ -145,9 +145,9 @@ The asyncComplete option in the HTTP task configuration allows tasks to be marke } ``` -Now, let’s run this in the Playground. +Now, let’s run this in the Developer Edition. -[Run in Orkes Playground](https://play.orkes.io/runWorkflow) +[Run in Orkes Developer Edition](https://developer.orkescloud.com/runWorkflow) 1. Under **Workflow Name**, choose **async_complete_example**. 2. Click **Run Workflow**. diff --git a/docs/sdks/authentication.md b/docs/sdks/authentication.md index 5a50d0fa..3312d9f0 100644 --- a/docs/sdks/authentication.md +++ b/docs/sdks/authentication.md @@ -84,7 +84,7 @@ Use the JWT token in the X-Authorization header for all your API calls. ``` shell // API call to a workflow called super_weather -curl -X "POST" "https://play.orkes.io/api/workflow/super_weather" \ +curl -X "POST" "https://developer.orkescloud.com/api/workflow/super_weather" \ -H 'Content-Type: application/json; charset=utf-8' \ -H 'X-Authorization: '\ -d '{ diff --git a/docs/sdks/golang.md b/docs/sdks/golang.md index aaa99cf5..d1e8beed 100644 --- a/docs/sdks/golang.md +++ b/docs/sdks/golang.md @@ -18,7 +18,7 @@ Everything related to server settings should be done within the `client.NewAPICl apiClient := client.NewAPIClient( nil, settings.NewHttpSettings( - "https://play.orkes.io", + "https://developer.orkescloud.com", ), ) @@ -38,7 +38,7 @@ Once we have a key and secret, we can configure the app from properties or envir SECRET, ), settings.NewHttpSettings( - "https://play.orkes.io", + "https://developer.orkescloud.com", ), ) diff --git a/docs/sdks/java.md b/docs/sdks/java.md index 99781312..4d9cb3c4 100644 --- a/docs/sdks/java.md +++ b/docs/sdks/java.md @@ -302,10 +302,10 @@ For running the workflow in Orkes Conductor, export CONDUCTOR_SERVER_URL="https://[your-cluster-name].orkesconductor.io/api" ``` -- If you want to run the workflow on the Orkes Conductor Playground, set the Conductor Server variable as follows: +- If you want to run the workflow on the Orkes Developer Edition, set the Conductor Server variable as follows: ```shell -export CONDUCTOR_SERVER_URL=https://play.orkes.io/api +export CONDUCTOR_SERVER_URL=https://developer.orkescloud.com/api ``` - Orkes Conductor requires authentication. [Obtain the key and secret from the Conductor server](https://www.youtube.com/watch?v=f1b5vZRKn2Q) and set the following environment variables. diff --git a/docs/sdks/python.md b/docs/sdks/python.md index e180c2cf..9f6a3eb3 100644 --- a/docs/sdks/python.md +++ b/docs/sdks/python.md @@ -227,10 +227,10 @@ For running the workflow in Orkes Conductor, export CONDUCTOR_SERVER_URL=https://[cluster-name].orkesconductor.io/api ``` -- If you want to run the workflow on the Orkes Conductor Playground, set the Conductor Server variable as follows: +- If you want to run the workflow on the Orkes Developer Edition, set the Conductor Server variable as follows: ```shell -export CONDUCTOR_SERVER_URL=https://play.orkes.io/api +export CONDUCTOR_SERVER_URL=https://developer.orkescloud.com/api ``` - Orkes Conductor requires authentication. [Obtain the key and secret from the Conductor server](https://www.youtube.com/watch?v=f1b5vZRKn2Q) and set the following environment variables. @@ -528,7 +528,7 @@ def send_email(email: str, subject: str, body: str): def main(): # defaults to reading the configuration using following env variables - # CONDUCTOR_SERVER_URL : conductor server e.g. https://play.orkes.io/api + # CONDUCTOR_SERVER_URL : conductor server e.g. https://developer.orkescloud.com/api # CONDUCTOR_AUTH_KEY : API Authentication Key # CONDUCTOR_AUTH_SECRET: API Auth Secret api_config = Configuration() diff --git a/docs/templates/alerting/querying-orkes-data-and-triggering-opsgenie-alert.md b/docs/templates/alerting/querying-orkes-data-and-triggering-opsgenie-alert.md index 081fec88..2332b612 100644 --- a/docs/templates/alerting/querying-orkes-data-and-triggering-opsgenie-alert.md +++ b/docs/templates/alerting/querying-orkes-data-and-triggering-opsgenie-alert.md @@ -52,7 +52,7 @@ We can also pass *correlationIds* and *freeText* just like on the Orkes workflow { "result": { "count": 1, - "workflowsUrl": "https://play.orkes.io?rowsPerPage=200&startFrom=1696447143843&startTo=1696448043843&status=FAILED&status=TERMINATED&workflowType=TestFailedWorkflow&workflowType=TestTerminatedWorkflow", + "workflowsUrl": "https://developer.orkescloud.com?rowsPerPage=200&startFrom=1696447143843&startTo=1696448043843&status=FAILED&status=TERMINATED&workflowType=TestFailedWorkflow&workflowType=TestTerminatedWorkflow", "workflows": [ { "updateTime": "2023-10-04T19:30:39.105Z", @@ -93,7 +93,7 @@ This system task sends the alert to Opsgenie using the API integration key store ```json { "alias": "SomeAlias", - "description": "https://play.orkes.io/rowsPerPage=200&startFrom=1696447143843&startTo=1696448043843&status=FAILED&workflowType=TestFailedWorkflow", + "description": "https://developer.orkescloud.com/rowsPerPage=200&startFrom=1696447143843&startTo=1696448043843&status=FAILED&workflowType=TestFailedWorkflow", "visibleTo": [ { "id": "6e771bf9-8a72-47c2-897d-ccab90df66e2/main", diff --git a/docs/templates/alerting/scanning-an-endpoint-and-triggering-pagerduty-alert.md b/docs/templates/alerting/scanning-an-endpoint-and-triggering-pagerduty-alert.md index 03fa7608..4ee74ec6 100644 --- a/docs/templates/alerting/scanning-an-endpoint-and-triggering-pagerduty-alert.md +++ b/docs/templates/alerting/scanning-an-endpoint-and-triggering-pagerduty-alert.md @@ -37,7 +37,7 @@ how the above logic is implemented.

Alert Workflow

-| [View in Playground](https://play.orkes.io/workflowDef/track_workflow_failures) | +| [View in Developer Edition](https://developer.orkescloud.com/workflowDef/track_workflow_failures) | |---------------------------------------------------------------------------------| @@ -123,7 +123,7 @@ how the above logic is implemented. } ``` -In this example, we are looking to find failure instances of the workflow **sample_tracker_workflow** on the playground +In this example, we are looking to find failure instances of the workflow **sample_tracker_workflow** on the Developer Edition environment of Orkes Conductor in a 10-minute window. An example payload for Pagerduty integration could look like: diff --git a/docs/templates/examples/api-processing-usps-example.md b/docs/templates/examples/api-processing-usps-example.md index f6e85bf5..d26881c8 100644 --- a/docs/templates/examples/api-processing-usps-example.md +++ b/docs/templates/examples/api-processing-usps-example.md @@ -8,11 +8,11 @@ The US Post Office has several APIs to simplify shipping. Let's look at how you The USPS can verify 160M addresses in the USA. This workflow either responds with the USPS version of the address (often in all CAPS), or with an error that the address was not found. -| [See it in Orkes Playground](https://play.orkes.io/workflowDef/check_address/1) | +| [See it in Orkes Developer Edition](https://developer.orkescloud.com/workflowDef/check_address/1) | |---------------------------------------------------------------------------------| :::note -This workflow requires a USPS username to be run. Change the name of the workflow - to save it in your Playground, and add your USPS Username in the Set_USPS_Name task. The [API access is free](https://www.usps.com/business/web-tools-apis/). +This workflow requires a USPS username to be run. Change the name of the workflow - to save it in your Developer Edition, and add your USPS Username in the Set_USPS_Name task. The [API access is free](https://www.usps.com/business/web-tools-apis/). :::

Document Approval Workflow

@@ -31,11 +31,11 @@ Sample input: Given a `toZip` and `fromZip`, and some dimensions of the box (and the shipping type), this workflow will output the price for that shipping type. -| [See it in Orkes Playground](https://play.orkes.io/workflowDef/postage_rate/1) | +| [See it in Orkes Developer Edition](https://developer.orkescloud.com/workflowDef/postage_rate/1) | |--------------------------------------------------------------------------------| :::note -This workflow requires a USPS username to be run. Change the name of the workflow - to save it in your Playground, and add your USPS Username in the Set_USPS_Name task. The [API access is free](https://www.usps.com/business/web-tools-apis/). +This workflow requires a USPS username to be run. Change the name of the workflow - to save it in your Developer Edition, and add your USPS Username in the Set_USPS_Name task. The [API access is free](https://www.usps.com/business/web-tools-apis/). :::

Document Approval Workflow

diff --git a/docs/templates/examples/custom-conductor-webhook-using-curl.md b/docs/templates/examples/custom-conductor-webhook-using-curl.md index 239608b7..ed3cd475 100644 --- a/docs/templates/examples/custom-conductor-webhook-using-curl.md +++ b/docs/templates/examples/custom-conductor-webhook-using-curl.md @@ -104,7 +104,7 @@ You need to send a request like this: ```shell curl -H "Content-Type:application/json" -H "Accept:application/json" \ -H 'someKey: someValue' \ - -X POST 'https://play.orkes.io/webhook/169d8857-ed45-4488-aefa-bf62cd8fb415' \ + -X POST 'https://developer.orkescloud.com/webhook/169d8857-ed45-4488-aefa-bf62cd8fb415' \ -d '{"event": {"type" : "type-1"}}' ``` diff --git a/docs/templates/examples/document-approvals.md b/docs/templates/examples/document-approvals.md index 5ea5a40a..19dbbbd0 100644 --- a/docs/templates/examples/document-approvals.md +++ b/docs/templates/examples/document-approvals.md @@ -14,7 +14,7 @@ A document can go through several levels of review based on the document type. T ## Sample Workflow for approving/rejecting documents -| [See the workflow in Orkes Playground](https://play.orkes.io/workflowDef/document_approval_test) | +| [See the workflow in Orkes Developer Edition](https://developer.orkescloud.com/workflowDef/document_approval_test) | |--------------------------------------------------------------------------------------------------| You can get the JSON file for the sample workflow detailed [here](https://github.com/conductor-sdk/conductor-examples/blob/main/document_approvals/review_approval.json). diff --git a/docs/templates/examples/finance.md b/docs/templates/examples/finance.md index 324753ae..9b9494e4 100644 --- a/docs/templates/examples/finance.md +++ b/docs/templates/examples/finance.md @@ -11,7 +11,7 @@ This workflow does not have workers that evaluate the loan parameters and is for You can get the JSON file for the sample workflow detailed [here](https://github.com/conductor-sdk/conductor-examples/blob/main/finance/loan_banking.json). -| [See it in Orkes Playground](https://play.orkes.io/workflowDef/loan_banking) | +| [See it in Orkes Developer Edition](https://developer.orkescloud.com/workflowDef/loan_banking) | |------------------------------------------------------------------------------|
diff --git a/docs/templates/video-processing-workflows.md b/docs/templates/video-processing-workflows.md index 52c7fe5a..d9877c9f 100644 --- a/docs/templates/video-processing-workflows.md +++ b/docs/templates/video-processing-workflows.md @@ -85,9 +85,9 @@ Now, let’s see how the workflow works! The template requires a worker to run the tasks. This section will walk you through the steps to write an external worker. -If you want to run the workflow quickly, you can try to run them in Orkes Playground. Since you haven’t set up the worker here, our Orkes workers will complete the task. Let’s see how to run this in the Playground. +If you want to run the workflow quickly, you can try to run them in Orkes Developer Edition. Since you haven’t set up the worker here, our Orkes workers will complete the task. Let’s see how to run this in the Developer Edition. -| [Run Video Recipe in Playground](https://play.orkes.io/runWorkflow) | +| [Run Video Recipe in Developer Edition](https://developer.orkescloud.com/runWorkflow) | |------------------------------------------------------------------------------| 1. Under **Workflow name**, choose the workflow **video_recipe.** @@ -116,9 +116,6 @@ We have used a video downloaded from [NASA Image and Video Library](https://imag When the workflow execution begins, the **orkesworkers** catch up the tasks, and the workflow gets completed. -| [View Sample Execution](https://play.orkes.io/execution/963cb659-be59-11ed-99ea-b2b080784892) | -|------------------------------------------------------------------------------| - The workflow output is stored in an Orkes-owned Amazon S3 bucket. In the output file, you can see the transcoded video with the Orkes logo as the watermark. | [View Sample Output with Watermark Recipe](https://image-processing-orkes.s3.amazonaws.com/f380e542-3a9c-486c-aecf-f91b855f7b36-WATERMARK.mp4) | @@ -205,12 +202,12 @@ To set up the connection between the worker and your Conductor instance: 5. Open your Java project, and navigate to [application.properties](https://github.com/orkes-io/orkes-templates/blob/main/video-processing/workers/java/src/main/resources/application.properties) file. ``` -conductor.server.url=https://play.orkes.io/api/ +conductor.server.url=https://developer.orkescloud.com/api/ conductor.security.client.key-id=your_key_id conductor.security.client.secret=your_key_secret ``` -Replace the above values with your credentials. If you are testing this in the playground, **conductor.server.url** field remains the same. If you are using your own Conductor server, replace the playground URL with your server URL. +Replace the above values with your credentials. If you are testing this in the Developer Edition, **conductor.server.url** field remains the same. If you are using your own Conductor server, replace the Developer Edition URL with your server URL. Next, you need to provide “execute” access to the workflows and tasks. 1. Inside the **Application** created, navigate to the section **Workflow and tasks permissions**. @@ -218,7 +215,7 @@ Next, you need to provide “execute” access to the workflows and tasks. 3. Under the **Workflow** section, search for **video_recipes** workflow and enable EXECUTE permissions. 4. Similarly, under the **Task** section and enable EXECUTE permissions for the tasks, **video_recipes_prefork**, and **video_recipes**. -This configuration ensures the connection between the worker and the Playground/Conductor. +This configuration ensures the connection between the worker and the Developer Edition/Conductor. #### Using Task to Domain diff --git a/docs/templates/visual-image-search.md b/docs/templates/visual-image-search.md index 586555bb..b2d0359e 100644 --- a/docs/templates/visual-image-search.md +++ b/docs/templates/visual-image-search.md @@ -66,9 +66,6 @@ You can navigate to the **Run Workflow** button on the left side of your Conduct

Run Workflow from UI

-| [View Sample Execution](https://play.orkes.io/execution/67ffc938-62c6-11ee-973c-6e520ab7b222?tab=workflowInputOutput) | -|--------------------------------------------------------------------------------------------------| - Here, the input image used was:

Input to the workflow

@@ -77,4 +74,4 @@ The output returned the following similar images:

Few sample output from the workflow

-The above image contains only 4 samples that were generated. You can check the complete samples generated from the [Workflow Output tab of this execution](https://play.orkes.io/execution/67ffc938-62c6-11ee-973c-6e520ab7b222?tab=workflowInputOutput). \ No newline at end of file +The above image contains only 4 samples that were generated. \ No newline at end of file