Orkes Conductor VS Code Extension

This extension is used to interact with Orkes Conductor from VS Code.

Features

The main navigation is through the Tree View on the left, as required by VS Code's UX guidelines.

In the Tree View, you can see the Clusters, the Workflow Definitions, the Tasks Definitions, the Executions, the Schedules.

These are the main items in the Tree View:

Clusters Menu:

• Add / Remove / Edit Clusters
• Download all Workflow Definitions
• List the Workflow Definitions in the cluster.

Workflows

• Push a workflow definition to cluster
• Push a task definition to cluster

Executions

• Run a workflow
• Terminate / Pause / Restart with current / Restart with latest

Schedules

• Start / Stop Schedules

Workflow Visualizer

• Renders the workflow's JSON.
• Highlights the clicked task in the code editor.
• Code Snippets for all SDKs.
• JSON Validation for Workflow Schemas.
• Compatible with both OSS and Orkes clusters.

Usage

Open a Folder or Repo

Opening a folder or repo is required to push workflows and tasks to the cluster, and to download the workflow definitions from the cluster.

The workflow definitions are saved in the folder you open, under the folder:

clusters/<cluster-name>/workflows

The task definitions are saved in the folder you open, under the folder:

clusters/<cluster-name>/tasks

Adding a new Cluster

You'll need to get a KeyId and KeySecret from your Conductor cluster.

1. Go to your Conductor UI.
2. Click on the "Applications" sidebar item.
3. Create a new Application.
4. Copy the KeyId and KeySecret.
5. Paste them into the "KeyId" and "KeySecret" fields in the Cluster settings.

Uploading a Workflow to your cluster

Filename conventions

The files are stored in a folder based on your cluster name under the /clusters dir of your workspace.

For example: /clusters/myCluster/workflows

The filename follows this convention: sendEmails.v1.workflow.json

Why .workflow.json? This provides features as Schema validation for your workflow files.

Why .v1, .v2, etc.? Conductor provides support for running multiple workflow versions, in parallel, which can be entirely different from each other.

You can keep different versions of your workflows, even schedule different versions as cron jobs.

How to upload a Workflow to your Cluster

1. Right-click on a workflow in your filesystem.
2. Click on the "Push to Cluster" option.

The workflow will be saved to your cluster.

Uploading a Task to your cluster

1. Right-click on a task in the tree view.
2. Click on the "Push to Cluster" option.

The task will be saved to your cluster.

Choosing a folder for the Workflow files.

1. Open the command palette (Ctrl+Shift+P).
2. Type "Orkes" to see the available settings.
3. Select a workflowFolder where the workflow files will be saved.

The folder is relative to the workspace root. You can also use an absolute path.