From f946e3c98bcaee9d993003e6006795704d1ccf3d Mon Sep 17 00:00:00 2001 From: christad92 Date: Thu, 29 Aug 2024 13:30:17 +0100 Subject: [PATCH 1/3] Added local deployment note --- docs/build/triggers.md | 48 +++++++++++++++++++++++++----------------- 1 file changed, 29 insertions(+), 19 deletions(-) diff --git a/docs/build/triggers.md b/docs/build/triggers.md index 8d292b96932..f1b08c39a56 100644 --- a/docs/build/triggers.md +++ b/docs/build/triggers.md @@ -101,21 +101,29 @@ published by a Kafka cluster. The triggers make use of Kafka consumer groups that are set up on-demand to receive messages from a defined cluster then converts them to `Input` dataclips that are used to initialize a Work Order. +:::info For Self Hosted OpenFn + +Instance administrators have to enable Kafka for their instance by setting +setting `KAFKA_TRIGGERS_ENABLED=yes` in the environment variable. + +::: + ![Configuring Kafka Trigger](/img/configuring-kafka.png) :::info What is Kafka? -Apache Kafka® is an event streaming platform designed to handle high volumes -of data. Check out [Kafka Docs](https://kafka.apache.org/documentation/#gettingStarted) -to learn more. +Apache Kafka® is an event streaming platform designed to handle high volumes of +data. Check out +[Kafka Docs](https://kafka.apache.org/documentation/#gettingStarted) to learn +more. ::: ### Configuring a Kafka trigger for your workflow 1. Create a new Workflow or open an existing Workflow in your Project -2. Click on the workflow's Trigger and change the trigger type to `Kafka Consumer` - in the `Trigger type` dropdown. +2. Click on the workflow's Trigger and change the trigger type to + `Kafka Consumer` in the `Trigger type` dropdown. 3. Fill out the required connection details: - **Hosts**: Provide the URL of the host(s) your trigger should listen to for @@ -124,29 +132,31 @@ to learn more. need at least one topic for a successful connection. - **SSL**: Some Kafka cluster require SSL connection. If you are connecting to an environment that requires SSL connection, select `Enable SSL`. -- **SSL Authentication**: Select the type of Authentication required for the Kafka - cluster. +- **SSL Authentication**: Select the type of Authentication required for the + Kafka cluster. - **Initial offset policy**: The intial offset dictates where the consumer starts reading messages from a topic when it subscribes for the first time. - There are three possible options: `earliest` messages available, `latest` - messages available, or messages with a specific `timestamp` (e.g., `1721889238000`). -- **Connect timeout**: The connect timeout specified in seconds (e.g., `30`) represents how - long the consumer should wait before timing out when attempting to connect - with a Kafka cluster. + There are three possible options: `earliest` messages available, `latest` + messages available, or messages with a specific `timestamp` (e.g., + `1721889238000`). +- **Connect timeout**: The connect timeout specified in seconds (e.g., `30`) + represents how long the consumer should wait before timing out when attempting + to connect with a Kafka cluster. 4. If you have not finished designing your Workflow or you're not ready to start - receiving messages from the Kafka cluster, please check the box to **disable + receiving messages from the Kafka cluster, please check the box to **disable the trigger** until you're ready for message ingestion to begin. :::warning Disable the trigger during workflow design Once the required connection information is provided via the modal, the trigger -will *immediately* start attempting to connect to the Kafka cluster. We advise that -the trigger is disabled until your workflow is ready to receive data from the cluster for -processing. **To stop the trigger from receiving and processing messages, check the `Disable -this trigger` checkbox at the bottom of the trigger configuration modal.** +will _immediately_ start attempting to connect to the Kafka cluster. We advise +that the trigger is disabled until your workflow is ready to receive data from +the cluster for processing. **To stop the trigger from receiving and processing +messages, check the `Disable this trigger` checkbox at the bottom of the trigger +configuration modal.** ::: -Learn how the initial `state` (and `Input`) for Kafka-triggered Workflows gets built -[here](../jobs/state#kafka-triggered-runs). +Learn how the initial `state` (and `Input`) for Kafka-triggered Workflows gets +built [here](../jobs/state#kafka-triggered-runs). From fc60c01cdf2f0b09e231eadc7467809aaa653dae Mon Sep 17 00:00:00 2001 From: christad92 Date: Thu, 29 Aug 2024 13:38:34 +0100 Subject: [PATCH 2/3] Note on self hosted deployment --- docs/build/triggers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/triggers.md b/docs/build/triggers.md index f1b08c39a56..84e9627d042 100644 --- a/docs/build/triggers.md +++ b/docs/build/triggers.md @@ -104,7 +104,7 @@ converts them to `Input` dataclips that are used to initialize a Work Order. :::info For Self Hosted OpenFn Instance administrators have to enable Kafka for their instance by setting -setting `KAFKA_TRIGGERS_ENABLED=yes` in the environment variable. + `KAFKA_TRIGGERS_ENABLED=yes` in the environment variable. ::: From 57205ddb0bfa3707656f56344a57b0010ef81d60 Mon Sep 17 00:00:00 2001 From: Aleksa Krolls Date: Sat, 14 Sep 2024 22:48:12 +0300 Subject: [PATCH 3/3] copy edits --- docs/build/triggers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/build/triggers.md b/docs/build/triggers.md index 84e9627d042..24560e4ed6c 100644 --- a/docs/build/triggers.md +++ b/docs/build/triggers.md @@ -101,7 +101,7 @@ published by a Kafka cluster. The triggers make use of Kafka consumer groups that are set up on-demand to receive messages from a defined cluster then converts them to `Input` dataclips that are used to initialize a Work Order. -:::info For Self Hosted OpenFn +:::info For self-hosted OpenFn deployments Instance administrators have to enable Kafka for their instance by setting `KAFKA_TRIGGERS_ENABLED=yes` in the environment variable.