-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from conductor-sdk/factory-methods-and-sync
- Loading branch information
Showing
14 changed files
with
1,089 additions
and
714 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,216 +1,45 @@ | ||
| # Netflix Conductor SDK - Clojure | ||
| # Netflix Conductor Clojure SDK | ||
|
|
||
| Software Development Kit for Netflix Conductor, written on and providing support for Clojure. | ||
| The `conductor-clojure` repository provides the client SDKs to build task workers in clojure | ||
|
|
||
| ## [Get SDK](https://clojars.org/io.orkes/conductor-clojure) | ||
| Building the task workers in clojure mainly consists of the following steps: | ||
|
|
||
| ## Quick Guide | ||
| 1. Setup conductor-clojure package | ||
| 2. [Create and run task workers](workers_sdk.md) | ||
| 3. [Create workflows using code](workflow_sdk.md) | ||
| 4. [Api Docs](docs/api/README.md) | ||
|
|
||
| ### Setup Conductor Clojure Package | ||
|
|
||
| ### Create connection options | ||
| * Get the package from clojars | ||
|
|
||
| ```clojure | ||
| (def options { | ||
| :url "http://localhost:8080/api/" ;; Conductor Server Path | ||
| :app-key "THIS-IS-SOME-APP-KEY" ;; Optional if using Orkes Conductor | ||
| :app-secret "THIS-IS-SOME-APP-SECRET" ;; Optional if using Orkes Conductor | ||
| } ) | ||
| ``` | ||
| ### Creating a task using the above options | ||
|
|
||
| ``` clojure | ||
| (ns some.namespace | ||
| (:require [io.orkes.metadata :as metadata]) | ||
|
|
||
| ;; Will Create a task. returns nil | ||
| (metadata/register-tasks options [{ | ||
| :name "cool_clj_task" | ||
| :description "some description" | ||
| :ownerEmail "somemail@mail.com" | ||
| :retryCount 3 | ||
| :timeoutSeconds 300 | ||
| :responseTimeoutSeconds 180 }]) | ||
| ) | ||
| ``` | ||
|
|
||
| ### Creating a Workflow that uses the above task | ||
|
|
||
| ``` clojure | ||
| (ns some.namespace | ||
| (:require [io.orkes.metadata :as metadata]) | ||
|
|
||
| ;; Will Register a workflow that uses the above task returns nil | ||
| (metadata/register-workflow-def options { | ||
| :name "cool_clj_workflow" | ||
| :description "created programatically from clj" | ||
| :version 1 | ||
| :tasks [ { | ||
| :name "cool_clj_task" | ||
| :taskReferenceName "cool_clj_task_ref" | ||
| :inputParameters {} | ||
| :type "SIMPLE" | ||
| } ] | ||
| :inputParameters [] | ||
| :outputParameters {:message "${clj_prog_task_ref.output.:message}"} | ||
| :schemaVersion 2 | ||
| :restartable true | ||
| :ownerEmail "owner@yahoo.com" | ||
| :timeoutSeconds 0 | ||
| })) | ||
|
|
||
| :deps {org.clojure/clojure {:mvn/version "1.11.0"} | ||
| io.orkes/conductor-clojure {:mvn/version "0.3.0"}} | ||
| ``` | ||
| ### Create and run a list of workers | ||
|
|
||
| ``` clojure | ||
| ;; Creates a worker and starts polling for work. will return an instance of Runner which can then be used to shutdown | ||
| (def shutdown-fn (runner-executor-for-workers | ||
| (list { | ||
| :name "cool_clj_task" | ||
| :execute (fn [someData] | ||
| [:completed {:message "Hi From Clj i was created programatically"}]) | ||
| }) | ||
| options )) | ||
|
|
||
| ;; Shutdown the polling for the workers defined above | ||
| (shutdown-fn) | ||
|
|
||
| ``` | ||
| ## Options | ||
| Options are a map with optional parameters. | ||
| ``` | ||
| (def options { | ||
| :url "http://localhost:8080/api/" ;; Api url (Optional will default to "http://localhost:8080") | ||
| :app-key "THIS-IS-SOME-APP-KEY" ;; Application Key (This is only relevant if you are using Orkes Conductor) | ||
| :app-secret "THIS-IS-SOME-APP-SECRET" ;; Application Secret (This is only relevant if you are using Orkes Conductor) | ||
| } ) | ||
| ``` | ||
| ## Configurations | ||
|
|
||
| ### Authentication Settings (Optional) | ||
| Configure the authentication settings if your Conductor server requires authentication. | ||
| * keyId: Key for authentication. | ||
| * keySecret: Secret for the key. | ||
|
|
||
| ## Metadata Namespace | ||
| Holds the functions to register workflows and tasks. | ||
| ### Access Control Setup | ||
| See [Access Control](https://orkes.io/content/docs/getting-started/concepts/access-control) for more details on role-based access control with Conductor and generating API keys for your environment. | ||
|
|
||
| `(:require [conductor.metadata :as metadata])` | ||
|
|
||
| ## Registering Tasks | ||
|
|
||
| Takes the options map and a list/vector of tasks to register. On success, it will return nil. | ||
| ### Configure API Client options | ||
|
|
||
| ```clojure | ||
| (metadata/register-tasks options [{ | ||
| :name "cool_clj_task_b" | ||
| :description "some description" | ||
| :ownerEmail "mail@gmail.com" | ||
| :retryCount 3 | ||
| :timeoutSeconds 300 | ||
| :responseTimeoutSeconds 180 }, | ||
| { | ||
| :name "cool_clj_task_z" | ||
| :description "some description" | ||
| :ownerEmail "mail@gmail.com" | ||
| :retryCount 3 | ||
| :timeoutSeconds 300 | ||
| :responseTimeoutSeconds 180 } | ||
| { | ||
| :name "cool_clj_task_x" | ||
| :description "some description" | ||
| :ownerEmail "mail@gmail.com" | ||
| :retryCount 3 | ||
| :timeoutSeconds 300 | ||
| :responseTimeoutSeconds 180 } | ||
| ]) | ||
| ``` | ||
|
|
||
| ## Registering a Workspace | ||
| ```clojure | ||
| (metadata/register-workflow-def options { | ||
| :name "cool_clj_workflow_2" | ||
| :description "created programatically from clj" | ||
| :version 1 | ||
| :tasks [ { | ||
| :name "cool_clj_task_b" | ||
| :taskReferenceName "cool_clj_task_ref" | ||
| :inputParameters {} | ||
| :type "SIMPLE" | ||
| }, | ||
| { | ||
| :name "something", | ||
| :taskReferenceName "other" | ||
| :inputParameters {} | ||
| :type "FORK_JOIN" | ||
| :forkTasks [[ | ||
| { | ||
| :name "cool_clj_task_z" | ||
| :taskReferenceName "cool_clj_task_z_ref" | ||
| :inputParameters {} | ||
| :type "SIMPLE" | ||
| } | ||
| ] | ||
| [ | ||
| { | ||
| :name "cool_clj_task_x" | ||
| :taskReferenceName "cool_clj_task_x_ref" | ||
| :inputParameters {} | ||
| :type "SIMPLE" | ||
| } | ||
| ] | ||
| ] | ||
| } | ||
| { | ||
| :name "join" | ||
| :type "JOIN" | ||
| :taskReferenceName "join_ref" | ||
| :joinOn [ "cool_clj_task_z", "cool_clj_task_x"] | ||
| } | ||
| ] | ||
| :inputParameters [] | ||
| :outputParameters {"message" "${clj_prog_task_ref.output.:message}"} | ||
| :schemaVersion 2 | ||
| :restartable true | ||
| :ownerEmail "mail@yahoo.com" | ||
| :timeoutSeconds 0 | ||
| :timeoutPolicy "ALERT_ONLY" | ||
| }) | ||
| ``` | ||
|
|
||
|
|
||
| ## TaskRunner Namespace | ||
| The taskrunner namespace holds the function to start a workflow and run a worker. | ||
|
|
||
| `[io.orkes.taskrunner :as conductor]` | ||
|
|
||
| ``` clojure | ||
| ;; Creates a worker and starts polling for work. will return an instance of Runner which can then be used to shutdown | ||
| (def shutdown-fn (conductor/runner-executor-for-workers | ||
| options | ||
| (list { | ||
| :name "cool_clj_task" | ||
| :execute (fn [someData] | ||
| [:completed {:message "Hi From Clj i was created programatically"}]) | ||
| }) | ||
| )) | ||
| ;;; define options | ||
| {:app-key "some-key", | ||
| :app-secret "some-secret", | ||
| :url "http://localhost:8080/api/"} | ||
|
|
||
| ;; Shutdown the polling for the workers defined above | ||
| (shutdown-fn) | ||
|
|
||
| ``` | ||
| The (runner-executor-for-workers) function will take a list of worker implementations, maps, and options and start polling for work. It will return a TaskRunnerConfigurer instance, which you can shut down by calling the .shutdown() java method. | ||
|
|
||
| ## Utils | ||
| Treat conductor workflows as simple tree data structures. | ||
|
|
||
|
|
||
| `[io.orkes.utils :as ut]` | ||
|
|
||
| ``` clojure | ||
| ;; Rename every single task to fakeName. Wil transverse the whole tree and applies the transformation function. | ||
|
|
||
| (ut/map-wf-tasks #(assoc % :name "fakeName") | ||
| wf-fork-example) | ||
|
|
||
| ;; Given a workflow wf-fork-example in this case will return a new workflow without the task with the taskReferenceName "cool_clj_task_ref" | ||
| (ut/filter-wf-tasks | ||
| #(not= (:taskReferenceName %) "cool_clj_task_ref") | ||
| wf-fork-example) | ||
|
|
||
| ``` | ||
| ### Next: [Create and run task workers](workers_sdk.md) | ||
|
|
||
| # Netflix Conductor SDK - Clojure | ||
|
|
||
| Software Development Kit for Netflix Conductor, written on and providing support for Clojure. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.