> For the complete documentation index, see [llms.txt](https://weplanx.gitbook.io/latest/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://weplanx.gitbook.io/latest/extend/worker.md).

# Worker

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/weplanx/worker/release.yml?label=release\&style=flat-square)](https://github.com/weplanx/worker/actions/workflows/release.yml) [![Release](https://img.shields.io/github/v/release/weplanx/worker.svg?style=flat-square\&include_prereleases)](https://github.com/weplanx/worker/releases) [![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/weplanx/worker?style=flat-square)](https://github.com/weplanx/worker) [![Go Report Card](https://goreportcard.com/badge/github.com/weplanx/worker?style=flat-square)](https://goreportcard.com/report/github.com/weplanx/worker) [![GitHub license](https://img.shields.io/github/license/weplanx/worker?style=flat-square)](https://raw.githubusercontent.com/weplanx/worker/main/LICENSE)

Distribution message event callback worker node

## Pre-requisite

* Nats cluster needs to enable JetStream
* Services and applications should work together the same nats tenant

## Deploy

The worker node subscribes to the work queue (non-persistent), including events from Schdule, MQ (message queue) and third-party. The node that gets the message triggers the event and transfers the result to the data stream. Node support horizontal expansion shunt pressure.

<figure><img src="https://460143175-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FPJVglrhNnlu3EQJde4Kk%2Fuploads%2FdBe5zlo6U5jwh0xFSvLe%2Fworker.png?alt=media&amp;token=755a8f4f-027e-4018-aa1f-422974891d55" alt=""><figcaption></figcaption></figure>

The main container image is:

* ghcr.io/weplanx/worker:latest
* registry.cn-shenzhen.aliyuncs.com/weplanx/worker:latest

The case will use Kubernetes deployment orchestration, replicate deployment (modify as needed).

```yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: worker
spec:
  selector:
    matchLabels:
      app: worker
  template:
    metadata:
      labels:
        app: worker
    spec:
      containers:
        - image: registry.cn-shenzhen.aliyuncs.com/weplanx/worker:latest
          imagePullPolicy: Always
          name: worker
          env:
            - name: MODE
              value: release
            - name: NATS_HOSTS
              value: <*** your nats hosts ***>
            - name: NATS_NKEY
              value: <*** your nats nkey***>
```

## Environement

### MODE

* Working mode, default `debug`

### NATS\_HOSTS <mark style="color:red;">\*required</mark>

* Nats connection host, use `,` split

### NATS\_NKEY <mark style="color:red;">\*required</mark>

* Nats NKEY authentication

## License

[BSD-3-Clause License](https://github.com/weplanx/worker/blob/main/LICENSE)