Conductor
Conductor is an orchestration engine that runs in the cloud.
Community
Please feel free to join our Gitter for questions and interacting with the community.
Access here other Conductor related projects made by the community! - Backup tool, Cron like workflow starter, Docker containers...
Builds
Conductor builds are run on Travis CI here.
Branch | Build | Coverage (coveralls.io) | Coverage (codecov.io) |
---|---|---|---|
master | |||
dev |
Documentation & Getting Started
http://netflix.github.io/conductor/
Getting Started guide.
Get Conductor
Binaries are available from Maven Central and jcenter.
Below are the various artifacts published:
Artifact | Description |
---|---|
conductor-common | Common models used by various conductor modules |
conductor-core | Core Conductor module |
conductor-redis-persistence | Persistence using Redis/Dynomite |
conductor-es5-persistence | Indexing using Elasticsearch 5.X |
conductor-jersey | Jersey JAX-RS resources for the core services |
conductor-ui | node.js based UI for Conductor |
conductor-contribs | Optional contrib package that holds extended workflow tasks and support for SQS |
conductor-client | Java client for Conductor that includes helpers for running a worker tasks |
conductor-server | Self contained Jetty server |
conductor-test-harness | Used for building test harness and an in-memory kitchensink demo |
Building
To build the server, use the following dependencies in your classpath:
- conductor-common
- conductor-core
- conductor-jersey
- conductor-redis-persistence (unless using your own persistence module)
- conductor-es5-persistence (unless using your own index module)
- conductor-contribs (optional)
Deploying Jersey JAX-RS resources
Add the following packages to classpath scan:
com.netflix.conductor.server.resources
com.netflix.workflow.contribs.queue
Conductor relies on the guice (4.0+) for the dependency injection. Persistence has a guice module to wire up appropriate interfaces:
com.netflix.conductor.dao.RedisWorkflowModule
Database Requirements
- The default persistence used is Dynomite
- For queues, we are relying on dyno-queues
- The indexing backend is Elasticsearch (5.x)
Other Requirements
- JDK 1.8+
- Servlet Container
Get Support
Conductor is maintained by Media Workflow Infrastructure team at Netflix. Use github issue tracking for any support request.
Contributions
Whether it is a small doc correction, bug fix or adding new module to support some crazy feature, contributions are highly appreciated. We just ask to follow standard oss guidelines. And to reiterate, please check with us before spending too much time, only to find later that someone else is already working on similar feature.
dev
branch is the current working branch, while master
branch is current stable branch. Please send your PR's to dev
branch, making sure that it builds on your local system successfully. Also, please make sure all the conflicts are resolved.
Feel free to create an issue with a label: question, with any questions or requests for help.
License
Copyright 2018 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.