Skip to content

Commit

Permalink
Add links, change to CloudEvent, and fix typos
Browse files Browse the repository at this point in the history
  • Loading branch information
tobiasschaefer authored and Lionel Untereiner committed Feb 8, 2022
1 parent bd3d85d commit 5aee6c1
Showing 1 changed file with 8 additions and 13 deletions.
21 changes: 8 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
[![Community Extension](https://img.shields.io/badge/Community%20Extension-An%20open%20source%20community%20maintained%20project-FF4700)](https://github.com/camunda-community-hub/community) [![Lifecycle: Incubating](https://img.shields.io/badge/Lifecycle-Incubating-blue)](https://github.com/Camunda-Community-Hub/community/blob/main/extension-lifecycle.md#incubating-)

# Zeebe Knative / Cloud Events Worker

This project focus in providing a bridge between Zeebe + BPMN to Knative and Cloud Events to provide Cloud Events orchestration using Zeebe Workflows.
# Zeebe Knative / CloudEvents Worker

This project focuses on providing a bridge between [Zeebe](http://zeebe.io/) + [BPMN](https://www.bpmn.org/) to [Knative](https://knative.dev/) and [CloudEvents](https://cloudevents.io/) to provide CloudEvents orchestration using Zeebe Workflows.

# Service Task Properties

Expand All @@ -16,21 +15,18 @@ Properties
- WAIT_TYPE: Cloud Event Type to wait

The worker has two modes:
- EMIT ONLY: It will emit a Cloud Event and complete the Job
- WAIT FOR CLOUD EVENT: It will wait to receive Cloud Event with a specific Type which will be correlated by the workflow and job key to complete the Service Task.

- EMIT ONLY: It will emit a CloudEvent and complete the Job
- WAIT FOR CLOUD EVENT: It will wait to receive CloudEvent with a specific Type which will be correlated by the workflow and job key to complete the Service Task.

# Endpoints

The worker expose HTTP Endpoints to recieve Cloud Events that can be propagated to workflows.

- / POST - > Receive Cloud Event via HTTP that will map to a Job
- /message POST -> Receive a Cloud Event that will be forwarded as a BPMN Message for an Intermediate Catch Event
The worker exposes HTTP Endpoints to receive CloudEvents that can be propagated to workflows.

- / POST - > Receive CloudEvent via HTTP that will map to a Job
- /message POST -> Receive a CloudEvent that will be forwarded as a BPMN Message for an Intermediate Catch Event

You can always access the Open API UI here: http://localhost:8080/swagger-ui.html


# Examples

## EMIT and WAIT
Expand All @@ -45,8 +41,7 @@ You can always access the Open API UI here: http://localhost:8080/swagger-ui.htm
## EMIT and CONTINUE:
> zbctl deploy emit-and-continue.bpmn --insecure
> zbctl create instance EMIT_AND_CONTINUE --variables "{\"myVarId\" : \"123\"}" --insecure
> curl -X POST localhost:8080/message -H "Content-Type: application/json" -H "Ce-Id: 536808d3" -H "Ce-Type: Cloud Event Response" -H "Ce-Source: curl" -H "CorrelationKey: 123" -d '{"name":"salaboy"}' -v
> curl -X POST localhost:8080/message -H "Content-Type: application/json" -H "Ce-Id: 536808d3" -H "Ce-Type: CloudEvent Response" -H "Ce-Source: curl" -H "CorrelationKey: 123" -d '{"name":"salaboy"}' -v
## TICKETS
Deploy workflow
Expand Down

0 comments on commit 5aee6c1

Please sign in to comment.