conductor README

The project's README from github.com/Netflix/conductor. As one markdown file: README.md.

Conductor

Announcement

Effective December 13, 2023, Netflix will discontinue maintenance of Conductor OSS on GitHub. This strategic decision, while difficult, is essential for realigning our resources to better serve our business objectives with our internal Conductor fork.

We are deeply grateful for your support and contributions over the years. While Netflix will no longer be maintaining this repo, members of the Conductor community have been active in promoting alternative forks of this project, we’ll leave the code as is and trust that the health of the community will remain strong and continue to develop moving forward.

Conductor

NetflixOSS Lifecycle Github release License

GitHub stars GitHub forks

Conductor is a platform created by Netflix to orchestrate workflows that span across microservices.

Releases

The final release is Github release

Workflow Creation in Code

Conductor supports creating workflows using JSON and Code.
SDK support for creating workflows using code is available in multiple languages and can be found at https://github.com/conductor-sdk

Community Contributions

The modules contributed by the community are housed at conductor-community. Compatible versions of the community modules are released simultaneously with releases of the main modules.

Discussion Forum: Please use the forum for questions and discussing ideas and join the community.

List of Conductor community projects: Backup tool, Cron like workflow starter, Docker containers and more.

Getting Started - Building & Running Conductor

Using Docker:

The easiest way to get started is with Docker containers. Please follow the instructions here.

From Source:

Conductor Server is a Spring Boot project and follows all applicable conventions. See instructions here.

Published Artifacts

Binaries are available from the Maven Central Repository.

Artifact Description
conductor-common Common models used by various conductor modules
conductor-core Core Conductor module
conductor-redis-persistence Persistence and queue using Redis/Dynomite
conductor-cassandra-persistence Persistence using Cassandra
conductor-es6-persistence Indexing using Elasticsearch 6.X
conductor-rest Spring MVC resources for the core services
conductor-ui node.js based UI for Conductor
conductor-client Java client for Conductor that includes helpers for running worker tasks
conductor-client-spring Client starter kit for Spring
conductor-java-sdk SDK for writing workflows in code
conductor-server Spring Boot Web Application
conductor-redis-lock Workflow execution lock implementation using Redis
conductor-awss3-storage External payload storage implementation using AWS S3
conductor-awssqs-event-queue Event queue implementation using AWS SQS
conductor-http-task Workflow system task implementation to send make requests
conductor-json-jq-task Workflow system task implementation to evaluate JSON using jq
conductor-grpc Protobuf models used by the server and client
conductor-grpc-client gRPC client to interact with the gRPC server
conductor-grpc-server gRPC server Application
conductor-test-harness Integration and regression tests

Database Requirements

Other Requirements

Get Support

There are several ways to get in touch with us:

Contributions

Whether it is a small documentation correction, bug fix or a new feature, contributions are highly appreciated. We just ask you to follow standard OSS guidelines. The Discussion Forum is a good place to ask questions, discuss new features and explore ideas. Please check with us before spending too much time, only to find out later that someone else is already working on a similar feature.

main branch is the current working branch. Please send your PR's to main branch, making sure that it builds on your local system successfully. Also, please make sure all the conflicts are resolved.

License

Copyright 2022 Netflix, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

conductor (Netflix/conductor)

Searching Database…

12.7K ·GitHub
Conductor
archived
What is this?Conductor is a platform built by Netflix to orchestrate workflows that span across multiple microservices.
Is this just a server, or does it come with a UI and client libraries too?It is a Spring Boot server application plus a separate Node.js-based UI for visualizing workflows, and Java/code SDKs for defining them.
How do I get Conductor running?The easiest way is with Docker containers, or you can build the Spring Boot server from source; published artifacts are also available on Maven Central.
What do I need installed to run it — a database, search engine, anything else?You need JDK 17+ for the server, Node 14 to build the UI, Redis for default persistence, and Elasticsearch 6.x as the indexing backend.
Is this project still maintained?No — Netflix discontinued maintenance of Conductor OSS on December 13, 2023, and the repo is archived; community members maintain active forks instead.
How do I actually define a workflow in Conductor?Workflows can be created either as JSON definitions or in code, with SDK support for writing workflows in multiple programming languages.
What persistence options does Conductor support besides Redis?The server also ships modules for Cassandra persistence and a Redis-based workflow execution lock, alongside AWS S3 for external payload storage and AWS SQS for event queues.
Does Conductor support gRPC as well as REST?Yes, it includes separate gRPC client and server modules with protobuf models, in addition to the Spring MVC REST resources.
Can I still use Conductor even though Netflix stopped maintaining it?Yes, the code remains on GitHub as-is and several community-maintained forks have emerged to continue development and support.
What are similar projects?conductor, temporal, dtm, microservices-demo, apollo, redisson, dapr, astron-agent
Which topics is it in?orchestrator, workflow-engine, workflows, spring-boot, grpc, reactjs, microservices, workflow-automation, redis, orchestration, distributed-systems, deprecated
Creator
Netflix
Size
28.8 MB
Stars
12.7K
Updated
CommitDec 13Releasev3.15.0Nov 26
Age
9y
Commits · 90 Days