Orkes Queues

Orkes Queues is a high performance queuing recipe based on the Redis as the underlying store.

   ______   .______       __  ___  _______     _______.
 /  __  \  |   _  \     |  |/  / |   ____|   /       |
|  |  |  | |  |_)  |    |  '  /  |  |__     |   (----`
|  |  |  | |      /     |    <   |   __|     \   \    
|  `--'  | |  |\  \----.|  .  \  |  |____.----)   |   
 \______/  | _| `._____||__|\__\ |_______|_______/    
                                                      
  ______      __    __   _______  __    __   _______     _______.
 /  __  \    |  |  |  | |   ____||  |  |  | |   ____|   /       |
|  |  |  |   |  |  |  | |  |__   |  |  |  | |  |__     |   (----`
|  |  |  |   |  |  |  | |   __|  |  |  |  | |   __|     \   \    
|  `--'  '--.|  `--'  | |  |____ |  `--'  | |  |____.----)   |   
 \_____\_____\\______/  |_______| \______/  |_______|_______/    

Getting Started

Orkes Queues is a library that can be used to create a message broker. Currently, the library is used as the underlying queuing infrastructure for Orkes Conductor

Requirements

1. Redis version 6.2+
2. The library supports Redis Standalone, Sentinel and Cluster modes
3. JDK 17+

Delivery semantics

Orkes Queues provides at-least once delivery semantics.

Using Library

Gradle

// https://mvnrepository.com/artifact/io.orkes.queues/orkes-conductor-queues
implementation 'io.orkes.queues:orkes-conductor-queues:VERSION'

Maven

<!-- https://mvnrepository.com/artifact/io.orkes.queues/orkes-conductor-queues -->
<dependency>
    <groupId>io.orkes.queues</groupId>
    <artifactId>orkes-conductor-queues</artifactId>
    <version>VERSION</version>
</dependency>

Using with Conductor

1. Update Netflix/Conductor's server module and add the following dependency:

    // https://mvnrepository.com/artifact/io.orkes.queues/orkes-conductor-queues
    implementation 'io.orkes.queues:orkes-conductor-queues:VERSION'

2. Set the configuration to use queues in your conductor.properties file:

   conductor.queue.type=redis_standalone

3. Add following line to Conductor.java

@ComponentScan(basePackages = {"com.netflix.conductor", "io.orkes.conductor"})

Contributions

We welcome community contributions and PRs to this repository.

Get Support

Use GitHub issue tracking for filing issues and Discussion Forum for any other questions, ideas or support requests. Orkes (http://orkes.io) development team creates and maintains the Orkes-Conductor releases.

License

Copyright 2022 Orkes, Inc Licensed under Orkes Community License. You may obtain a copy of the License at:

https://github.com/orkes-io/licenses/blob/main/community/LICENSE.txt

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.