README.md

Screwdriver Queue Service API

Table of Contents

• Background
• Installation and Usage
• Configuration
• Testing
• Contribute
• License

Background

Screwdriver Queue Service is created to decouple the build queueing mechanism from Screwdriver APIs. It is a REST service with the idea of being highly available and resilient.

Installation and Usage

    npm install
    npm start

Plugins

This API comes with 2 resources:

• executor
• worker

Prerequisites

To use Screwdriver Queue Service, you will need the following prerequisites:

• Node v12.0.0 or higher
• Redis

Contribute

To start contributing to Screwdriver, have a look at our guidelines, as well as pointers on where to start making changes, in our contributing guide.

License

Code licensed under the BSD 3-Clause license. See LICENSE file for terms.