https://github.com/openfaas/nats-queue-worker

Queue-worker for OpenFaaS with NATS Streaming
https://github.com/openfaas/nats-queue-worker

cluster docker nats nats-streaming

Last synced: 5 months ago
JSON representation

Queue-worker for OpenFaaS with NATS Streaming

• Host: GitHub
• URL: https://github.com/openfaas/nats-queue-worker
• Owner: openfaas
• License: mit
• Created: 2017-08-18T13:29:07.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-12-09T09:51:00.000Z (10 months ago)
• Last Synced: 2025-04-08T12:03:25.666Z (6 months ago)
• Topics: cluster, docker, nats, nats-streaming
• Language: Go
• Homepage: https://docs.openfaas.com/reference/async/
• Size: 5.05 MB
• Stars: 130
• Watchers: 8
• Forks: 59
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
## Notice

[NATS Streaming](https://github.com/nats-io/nats-streaming-server) was deprecated in June 2023 by Synadia, and will receive no more updates, including for critical security issues.

Migrate to OpenFaaS Standard for NATS JetStream, learn more:

* [Docs: JetStream for OpenFaaS](https://docs.openfaas.com/openfaas-pro/jetstream/)

* [Announcement: The Next Generation of Queuing: JetStream for OpenFaaS](https://www.openfaas.com/blog/jetstream-for-openfaas/)

## queue-worker (Community Edition) for NATS Streaming

[![Go Report Card](https://goreportcard.com/badge/github.com/openfaas/nats-queue-worker)](https://goreportcard.com/badge/github.com/openfaas/nats-queue-worker)

[![Build Status](https://travis-ci.com/openfaas/nats-queue-worker.svg?branch=master)](https://travis-ci.com/openfaas/nats-queue-worker)

[![go.dev reference](https://img.shields.io/badge/go.dev-reference-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/openfaas/nats-queue-worker?tab=overview)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![OpenFaaS](https://img.shields.io/badge/openfaas-serverless-blue.svg)](https://www.openfaas.com)

[![Derek App](https://alexellis.o6s.io/badge?owner=openfaas&repo=nats-queue-worker)](https://github.com/alexellis/derek/)

The queue-worker (Community Edition) processes asynchronous function invocation requests, you can read more about this in the [async documentation](https://docs.openfaas.com/reference/async/)

## Usage

Screenshots from keynote / video - find out more over at https://www.openfaas.com/







### Configuration

| Parameter               | Description                           | Default                                                    |

| ----------------------- | ----------------------------------    | ---------------------------------------------------------- |

| `write_debug` | Print verbose logs | `false` |

| `faas_gateway_address` | Address of gateway DNS name | `gateway` |

| `faas_gateway_port` | Port of gateway service | `8080` |

| `faas_max_reconnect` | An integer of the amount of reconnection attempts when the NATS connection is lost | `120` |

| `faas_nats_address` | The host at which NATS Streaming can be reached | `nats` |

| `faas_nats_port` | The port at which NATS Streaming can be reached | `4222` |

| `faas_nats_cluster_name` | The name of the target NATS Streaming cluster | `faas-cluster` |

| `faas_reconnect_delay` | Delay between retrying to connect to NATS | `2s` |

| `faas_print_body` | Print the body of the function invocation | `false` |