⚠️ Only applies to this fork
We are using a subset (specialized build) of conductor including some compontents from conductor-community and orkes-conductor-community.
FRINX fork of conductor: this FRINX fork of conductor community: https://github.com/FRINXio/conductor-community
- FRINX fork of conductor also includes python client which in upstream is now located at: https://github.com/conductor-sdk/conductor-python
- FRINX fork of conductor community also incldues packages from orkes-conductor-community, namely the archive package
Conductor/server produces a build specific to us. We do not build / test all the components.
To run and debug conductor locally follow these steps:
- Start empty postgres and elasticsearch containers
docker rm -f elasticsearch && docker rm -f psql && docker run -d --name elasticsearch -p 9200:9200 -p 9300:9300 -e "discovery.type=single-node" elasticsearch:6.7.1 && docker run --name psql -p 5432:5432 -e POSTGRES_PASSWORD=postgres -d postgres postgres -c shared_preload_libraries=pg_stat_statements -c pg_stat_statements.track=all -c max_connections=200
Note Conductor can run with different databases. In this case we are assuming primaryDB == postgres && indexDB == elastic v. 6 In case both primary and index DB are postgres, there's no need to run elasticsearch
- Run conductor
./gradlew bootRun --debug-jvm
Note Configuration used is located here:
server/src/main/resources/application.properties
- Attach debugger from your favourite IDE
- Run some workers. Our base workers can be started with:
git clone [email protected]:FRINXio/fm-workflows.git
cd fm-workflows/
cd demo-workflows/
python3 -m venv venv
source venv/bin/activate
pip3 install -r requirements.txt
cd workers
CONDUCTOR_URL_BASE=http://localhost:8080/api python3 ./main.py
Conductor is a platform created by Netflix to orchestrate workflows that span across microservices. Conductor is maintained by Media Workflow Infrastructure team at Netflix.
For more information, see Main Documentation Site
2.31.8 is the final release of 2.31
branch. As of Feb 2022, 1.x
& 2.x
versions are no longer supported.
We have an active community of Conductor users and contributors on the channel.
Documentation and tutorial on how to use Conductor
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
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.
The easiest way to get started is with Docker containers. Please follow the instructions here.
Conductor Server is a Spring Boot project and follows all applicable conventions. See instructions here.
Binaries are available from Netflix OSS Maven repository, or 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 |
- The default persistence used is Redis
- The indexing backend is Elasticsearch (6.x)
- JDK 17+
- UI requires Node 14 to build. Earlier Node versions may work but is untested.
There are several ways to get in touch with us:
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.
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.