Skip to content
This repository has been archived by the owner on Dec 13, 2023. It is now read-only.

Commit

Permalink
readme updates with new branch names
Browse files Browse the repository at this point in the history
  • Loading branch information
@aravindanr
aravindanr committed Apr 1, 2021
1 parent 7c74dc9 commit e34c933
Showing 1 changed file with 17 additions and 28 deletions.
45 changes: 17 additions & 28 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,18 +19,18 @@ Conductor is an _orchestration_ engine that runs in the cloud.
## Builds
Conductor builds are run on Travis CI [here](https://travis-ci.com/Netflix/conductor).

| Branch | Build | Coverage (coveralls.io) | Coverage (codecov.io) |
|:------:|:-------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------------------------------------------------------:|:----------------------------------------------------------------------------------------------------------------------------------:|
| master | [![Build Status](https://travis-ci.com/Netflix/conductor.svg?branch=master)](https://travis-ci.com/Netflix/conductor) | [![Coverage Status](https://coveralls.io/repos/github/Netflix/conductor/badge.svg?branch=master)](https://coveralls.io/github/Netflix/conductor?branch=master) | [![codecov](https://codecov.io/gh/Netflix/conductor/branch/master/graph/badge.svg)](https://codecov.io/gh/Netflix/conductor/branch/master) |
| dev | [![Build Status](https://travis-ci.com/Netflix/conductor.svg?branch=dev)](https://travis-ci.com/Netflix/conductor) | [![Coverage Status](https://coveralls.io/repos/github/Netflix/conductor/badge.svg?branch=dev)](https://coveralls.io/github/Netflix/conductor?branch=dev) | [![codecov](https://codecov.io/gh/Netflix/conductor/branch/dev/graph/badge.svg)](https://codecov.io/gh/Netflix/conductor/branch/dev) |
| Branch | Build |
|:------:|:-------------------------------------------------------------------------------------------------------------:|
| main | [![Build Status](https://travis-ci.com/Netflix/conductor.svg?branch=master)](https://travis-ci.com/Netflix/conductor) |
| 2.31 | [![Build Status](https://travis-ci.com/Netflix/conductor.svg?branch=2.31)](https://travis-ci.com/Netflix/conductor) |

## Documentation & Getting Started
[http://netflix.github.io/conductor/](http://netflix.github.io/conductor/)

[Getting Started](https://netflix.github.io/conductor/gettingstarted/basicconcepts/) guide.

## Get Conductor
Binaries are available from Maven Central and jcenter.
Binaries are available from Maven Central.

Below are the various artifacts published:

Expand All @@ -39,12 +39,16 @@ Below are the various artifacts published:
|conductor-common|Common models used by various conductor modules|
|conductor-core|Core Conductor module|
|conductor-redis-persistence|Persistence using Redis/Dynomite|
|conductor-cassandra-persistence|Persistence using Cassandra|
|conductor-mysql-persistence|Persistence and queue using MySQL|
|conductor-postgres-persistence|Persistence and queue using Postgres|
|conductor-es5-persistence|Indexing using Elasticsearch 5.X|
|conductor-jersey|Jersey JAX-RS resources for the core services|
|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-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-client|Java client for Conductor that includes helpers for running worker tasks|
|conductor-server|Spring Boot Web Application|
|conductor-test-harness|Used for building test harness and an in-memory kitchensink demo|

## Building
Expand All @@ -54,45 +58,30 @@ To build the server, use the following dependencies in your classpath:
* conductor-core
* conductor-jersey
* conductor-redis-persistence (_unless using your own persistence module_)
* conductor-es5-persistence (_unless using your own index module_)
* conductor-es6-persistence (_unless using your own index module_)
* conductor-contribs (_optional_)


### Deploying Jersey JAX-RS resources
Add the following packages to classpath scan:

```java
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:

```java
com.netflix.conductor.dao.RedisWorkflowModule
```
## Database Requirements

* The default persistence used is [Dynomite](https://github.com/Netflix/dynomite)
* For queues, we are relying on [dyno-queues](https://github.com/Netflix/dyno-queues)
* The indexing backend is [Elasticsearch](https://www.elastic.co/) (5.x)
* The indexing backend is [Elasticsearch](https://www.elastic.co/) (6.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.
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 a 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.
`main` branch is the current working branch, while `2.31` branch is the latest stable 2.x 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.

Feel free to create an issue with a label: question, with any questions or requests for help.

## License
Copyright 2018 Netflix, Inc.
Copyright 2021 Netflix, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down

0 comments on commit e34c933

Please sign in to comment.