Awesome
Conductor is a platform originally created at Netflix to orchestrate microservices and events. Conductor OSS is maintained by the team of developers at Orkes.io along with members of the open source community.
Table of Contents
- What is Conductor?
- Getting Started
- Documentation
- Database Specifications
- Deployment Options
- Conductor Roadmap
- How to Contribute
- Additional Resources
- Community & Support
What is Conductor?
Conductor (or Netflix Conductor) is a microservices orchestration engine for distributed and asynchronous workflows. It empowers developers to create workflows that define interactions between services, databases, and other external systems.
Conductor is designed to enable flexible, resilient, and scalable workflows. It allows you to compose services into complex workflows without coupling them tightly, simplifying orchestration across cloud-native applications and enterprise systems alike.
Key benefits
- Resilience and Error Handling: Conductor enables automatic retries and fallback mechanisms.
- Scalability: Built to scale with complex workflows in high-traffic environments.
- Observability: Provides monitoring and debugging capabilities for workflows.
- Ease of Integration: Seamlessly integrates with microservices, external APIs, and legacy systems.
Features
- Workflow as Code: Define workflows in JSON and manage them with versioning.
- Rich Task Types: Includes task types like HTTP, JSON, Lambda, Sub Workflow, and Event tasks, allowing for flexible workflow definitions.
- Dynamic Workflow Management: Workflows can evolve independently of the underlying services.
- Built-in UI: A customizable UI is available to monitor and manage workflows.
- Flexible Persistence and Queue Options: Use Redis, MySQL, Postgres, and more.
Getting Started
Requirements
- Install Docker Desktop (Mac, Windows/PC, Linux)
- Install Java (JDK) 17 or newer
- Node 14 for the UI to build
- Earlier versions may work, but are untested
Quick Start Guide
Clone the repo
git clone https://github.com/conductor-oss/conductor
Change to new Conductor directory
cd conductor
Start with Docker Compose (recommended for local deployment)
docker compose -f docker/docker-compose.yaml up
Create your first workflow
To create a workflow, navigate to the UI:
Or use the REST API with your preferred HTTP client
Documentation
Check-out the Conductor OSS docs for additional details
Database Specifications
- The default persistence used is Redis
- The indexing backend is Elasticsearch (7.x)
Configuration for various database backends
| Backend | Configuration |
|---|---|
| Redis + ES7 | config-redis.properties |
| Postgres | config-postgres.properties |
| Postgres + ES7 | config-postgres-es7.properties |
| MySQL + ES7 | config-mysql.properties |
Deployment Options
In addition to the Docker Compose setup, Netflix Conductor supports several other deployment methods to suit various environments:
- Docker: Outlined above
- Custom Deployment: Build from source and deploy Conductor as a standalone Java application. Configure databases, queues, and environment settings as needed.
Available SDKs
Conductor provides several SDKs for interacting with the API and creating custom clients:
- Java SDK: Fully featured for building and executing workflows in Java.
- Python SDK: Python library for creating and managing workflows.
- Go SDK: For integrating Conductor workflows with Go-based services.
- C# (C sharp) SDK:The conductor-csharp repository provides the client SDKs to build task workers in C#
Each SDK is maintained as part of the Conductor project, providing examples and comprehensive API documentation.
Conductor OSS Roadmap
See the roadmap for the Conductor If you would like to participate in the roadmap and development, please reach out.
Documentation and Community
- Official Documentation: Conductor documentation contains detailed explanations of workflow concepts, API reference, and guides.
- Conductor Slack: Join the Conductor Slack channel for community discussions and support.
- Orkes Community Discourse: Hosted by Orkes.io on Discourse, you can engage the Conductor & Orkes community, ask questions, and contribute ideas.
License
Conductor is licensed under the Apache 2.0 License © Conductor Open-source
Contributing
We welcome contributions from everyone!
- Report Issues: Found a bug or have a feature request? Open an issue on GitHub.
- Contribute Code: Check out our Contribution Guide for initial guidelines, and explore our good first issues for beginner-friendly tasks to tackle first.
- Build a Conductor SDK: Need an SDK not included with Conductor? Build your own using the Swagger API included with your local deployment.
- Contribute to our Docs: Contribute edits or updates to keep our documentation in great shape for the community.