Conductor is an orchestration engine that runs in the cloud.
To get started with conductor, after cloning this repository, change dynomite and elastic search properties in the following file:
docker/server/config/config.properties
To look like this:
workflow.dynomite.cluster.hosts= dyno1:8102:us-east-1c
workflow.elasticsearch.url= es:9300
Then start the services using docker:
cd docker
docker-compose up
This will launch UI at http://localhost:5000/.
Note: The server will load a sample kitchensink workflow definition by default.
Clone conductor_metadata and run:
python migration.py --delete
This will add the existing workflow definitions to your local instance.
Clone conductor_api and follow the README to get the API up and running.
Conductor builds are run on Travis CI here.
Branch | Build | Coverage (coveralls.io) | Coverage (codecov.io) |
---|---|---|---|
master | |||
dev |
http://netflix.github.io/conductor/
Getting Started guide.
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 |
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)
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
- The default persistence used is Dynomite
- For queues, we are relying on dyno-queues
- The indexing backend is Elasticsearch (5.x)
- JDK 1.8+
- Servlet Container
Conductor is maintained by Media Workflow Infrastructure team at Netflix. Use github issue tracking for any support request.
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.
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.
If you get an error similar to this, make sure the port is not being used by executing lsof -t -i:8080
.
When nothing is running in that port but the error persists, make sure there are no services configured to listen on that port, like nginx.