Add documentation for the RabbitMQ connector

Signed-off-by: Han Verstraete (OpenFaaS Ltd) <[email protected]>

Author: welteki

docs/openfaas-pro/rabbitmq-events.md

@@ -0,0 +1,88 @@
+# Trigger function from RabbitMQ
+
+Trigger OpenFaaS functions from RabbitMQ messages.
+
+> Note: This feature is included for [OpenFaaS Standard & For Enterprises](https://openfaas.com/pricing/) customers.
+
+## Installation
+
+* Setup the connector
+
+    You can install the RabbitMQ connector using its [helm chart](https://github.com/openfaas/faas-netes/tree/master/chart/rabbitmq-connector).
+
+    The `values.yaml` file can be customised to suit your needs.
+
+*  Configure the connector for you needs by defining a values.yaml file
+
+    ```yaml
+    rabbitmqURL: "amqp://rabbitmq.rabbitmq.svc.cluster.local:5672"
+
+    queues:
+      - name: queue1
+        durable: true
+    ```
+
+Use the `queues` parameter to configure a list of queues to which the connector should subscribe. When a message is received on a queue, the connector will invoke any function that has the queue name listed in its `topic` annotation.
+
+Queue configuration:
+
+* `name` - The name of the queue. (Required)
+* `durable` - Specifies whether the queue should survive broker restarts.
+* `nowait` - Whether to wait for confirmation from the server when declaring the queue.
+* `autodelete` - Whether the queue should be deleted automatically when no consumers are connected.
+* `exclusive` - Specifies whether the queue should be exclusive to the connection that created it.
+
+If your RabbitMQ requires a TLS connection make sure to use `amqps://` as the scheme in the url.
+
+## Usage
+
+To test the connector, you can deploy the [printer function](https://github.com/openfaas/store-functions/blob/master/printer/handler.go). It prints out the HTTP headers and body of any invocation.
+
+Add an annotation `topic=queue1` so that the function is invoked for any message published to the queue with name queue1.
+Each time a function is invoked by the connector it will receive the message from the queue as the HTTP body.
+
+```bash
+faas-cli store deploy printer \
+  --annotation topic=queue1
+```
+
+Publish a message on the queue for testing. We will be using the [RabbitMQ management CLI](https://www.rabbitmq.com/docs/management-cli) for this.
+
+```bash
+./rabbitmqadmin publish \
+  routing_key="queue1" payload='Hello, Task Queue!' properties='{"message_id":"1"}'
+```
+
+Take a look at the logs of the printer function to inspect the invocations made by the connector. You should see the following output:
+
+```bash
+faas-cli logs printer
+
+2024-12-02T16:58:49Z X-Forwarded-For=[10.42.0.4:58102]
+2024-12-02T16:58:49Z X-Msg-Id=[1]
+2024-12-02T16:58:49Z X-Start-Time=[1733158729048068067]
+2024-12-02T16:58:49Z X-Call-Id=[ea459d66-e1af-4846-9f73-18561f69074f]
+2024-12-02T16:58:49Z X-Connector=[connector-sdk]
+2024-12-02T16:58:49Z X-Topic=[queue1]
+2024-12-02T16:58:49Z User-Agent=[openfaas-gateway/0.4.34]
+2024-12-02T16:58:49Z Accept-Encoding=[gzip]
+2024-12-02T16:58:49Z Content-Type=[text/plain]
+2024-12-02T16:58:49Z X-Forwarded-Host=[gateway.openfaas:8080]
+2024-12-02T16:58:49Z 
+2024-12-02T16:58:49Z Hello, Task Queue!
+2024-12-02T16:58:49Z 
+2024-12-02T16:58:49Z 2024/12/02 16:58:49 POST / - 202 Accepted - ContentLength: 0B (0.0003s)
+```
+
+Additional headers are made available to the request. These headers contain RabbitMQ message metadata.
+
+* `X-Topic` - topic that triggered the function.
+* `X-Msg-Id` - the message identifier.
+
+The default content-type is configured as `text/plain`, but can be changed to another content-type such as `application/json` or `application/octet-stream` by the [values.yaml file](https://github.com/openfaas/faas-netes/blob/master/chart/kafka-connector/values.yaml) for the connector.
+
+## Would you like a demo?
+
+Feel free to reach out to us for a demo or to ask any questions you may have.
+
+* [Talk to us](https://openfaas.com/pricing/)

docs/reference/triggers.md

@@ -85,6 +85,12 @@ If you are unable to expose a public endpoint for any reason, and still need eve
 
 [Read the documentation](/openfaas-pro/sns-events)
 
+### RabbitMQ
+
+Trigger your functions from messages published to RabbitMQ queues.
+
+[Read the documentation](/openfaas-pro/rabbitmq-events)
+
 ### Cron Connector
 
 The [cron-connector](https://github.com/openfaas/cron-connector) can be used to trigger functions on a timed schedule. It uses traditional cron expressions.
@@ -124,11 +130,6 @@ No connector is required to trigger OpenFaaS functions using CloudEvents.
 
 Follow this example to learn how to trigger functions using the Azure EventGrid and CloudEvents: [johnmccabe/cloudevents-slack-demo](https://github.com/johnmccabe/cloudevents-slack-demo)
 
-### RabbitMQ (third-party project)
-
-Invoke functions from RabbitMQ topics. This is a third party project.
-
-More information in the repository: [templum/rabbitmq-connector](https://github.com/Templum/rabbitmq-connector)
 
 ### VMware vCenter
 

mkdocs.yml

@@ -162,6 +162,7 @@ nav:
       - Postgres events: ./openfaas-pro/postgres-events.md
       - AWS SQS events: ./openfaas-pro/sqs-events.md
       - AWS SNS events: ./openfaas-pro/sns-events.md
+      - RabbitMQ events: ./openfaas-pro/rabbitmq-events.md
       # - Federated Gateway: ./openfaas-pro/federated-gateway.md
       - Airgapped installation: ./openfaas-pro/airgap.md
       - Function Builder API: ./openfaas-pro/builder.md