adding Kafka Destination docs #6280

joe-ayoub-segment · 2024-03-25T14:20:50Z

Adding docs for new Kafka Destination

Proposed changes

Adding docs for new Kafka Destination
Destination slug is: actions-kafka

Merge timing

Please publish but keep it hidden from customers for now until the Destination is in Public Beta.

Related issues (optional)

forstisabella · 2024-03-25T16:12:02Z

src/connections/destinations/catalog/kafka/index.md

@@ -0,0 +1,71 @@
+---
+title: Kafka Destination


hi @joe-ayoub-segment - do you know the ID for this destination?

also - if the slug is actions-kafka, you'll need to either rename the file or add a redirect to the frontmatter so that the app/segment.com site can correctly point to these docs

Hi @forstisabella the ID is 65dde5755698cb0dab09b489

I'll rename the folder to actions-kafka

sweet! thanks. It looks good to me, but I'm going to hold off on deploying this today, as I haven't figured out how to keep the ordered lists from resetting under each heading (and the Jira ticket has a docs required date of March 29th, so I've got some time to work through this).

forstisabella

A few changes and we'll be good to go! I'll take a deeper look at the numbering, as I don't think it'll reset if you add a header between lists

forstisabella · 2024-03-25T16:12:17Z

src/connections/destinations/catalog/kafka/index.md

@@ -0,0 +1,71 @@
+---
+title: Kafka Destination


Suggested change

title: Kafka Destination

title: Kafka Destination

beta: true

hidden: true

id:

forstisabella · 2024-03-25T16:15:26Z

src/connections/destinations/catalog/kafka/index.md

+
+[Kafka](https://kafka.apache.org/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} provides a highly scalable and fault-tolerant messaging system that enables real-time data processing and stream processing at scale. When integrated with Segment, Kafka serves as a powerful backbone for managing and processing event data collected by Segment, allowing businesses to efficiently ingest, route, and analyze data across various applications and systems in real time.
+
+This destination is maintained by Segment. 


Suggested change

This destination is maintained by Segment.

This destination is maintained by Segment. For any issues with the destination, [contact the Segment Support team](mailto:friends@segment.com).

forstisabella · 2024-03-25T16:15:39Z

src/connections/destinations/catalog/kafka/index.md

+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Kafka"
+2. Select the "Kafka" tile and click **Add Destination**


Suggested change

1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Kafka"

2. Select the "Kafka" tile and click **Add Destination**

1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Kafka".

2. Select the "Kafka" tile and click **Add Destination**.

forstisabella · 2024-03-25T16:23:54Z

src/connections/destinations/catalog/kafka/index.md

+
+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Kafka"
+2. Select the "Kafka" tile and click **Add Destination**
+3. Select an existing Source to connect to Kafka.


Suggested change

3. Select an existing Source to connect to Kafka.

3. Select an existing source to connect to Kafka.

forstisabella · 2024-03-25T16:23:57Z

src/connections/destinations/catalog/kafka/index.md

+1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Kafka"
+2. Select the "Kafka" tile and click **Add Destination**
+3. Select an existing Source to connect to Kafka.
+4. Give your Kafka Destination a name.


Suggested change

4. Give your Kafka Destination a name.

4. Enter a name for your Kafka destination.

forstisabella · 2024-03-25T16:49:51Z

src/connections/destinations/catalog/kafka/index.md

+   For **AWS**: Provide values for **AWS Access Key ID** and **AWS Secret Key** fields, and optionally for the **AWS Authorization Identity** field. 
+   For **Client Certificate** you will need to provide values for the **SSL Client Key** and **SSL Client Certificate** Settings fields. 
+7. Optionally populate the **SSL Certificate Authority** field. 
+8. Save your changes before proceeding to the next step. 


Suggested change

8. Save your changes before proceeding to the next step.

8. Save your changes and proceed to Configure the Send Action .

forstisabella · 2024-03-25T16:49:53Z

src/connections/destinations/catalog/kafka/index.md

+   For **Plain** or **SCRAM-SHA-256 / 512**: provide values for **Username** and **Password** fields.
+   For **AWS**: Provide values for **AWS Access Key ID** and **AWS Secret Key** fields, and optionally for the **AWS Authorization Identity** field. 
+   For **Client Certificate** you will need to provide values for the **SSL Client Key** and **SSL Client Certificate** Settings fields. 
+7. Optionally populate the **SSL Certificate Authority** field. 


Suggested change

7. Optionally populate the **SSL Certificate Authority** field.

7. Populate the **SSL Certificate Authority** field, if necessary.

forstisabella · 2024-03-25T16:54:12Z

src/connections/destinations/catalog/kafka/index.md

+   For **Plain** or **SCRAM-SHA-256 / 512**: provide values for **Username** and **Password** fields.
+   For **AWS**: Provide values for **AWS Access Key ID** and **AWS Secret Key** fields, and optionally for the **AWS Authorization Identity** field. 
+   For **Client Certificate** you will need to provide values for the **SSL Client Key** and **SSL Client Certificate** Settings fields. 


Suggested change

For **Plain** or **SCRAM-SHA-256 / 512**: provide values for **Username** and **Password** fields.

For **AWS**: Provide values for **AWS Access Key ID** and **AWS Secret Key** fields, and optionally for the **AWS Authorization Identity** field.

For **Client Certificate** you will need to provide values for the **SSL Client Key** and **SSL Client Certificate** Settings fields.

- **Plain** or **SCRAM-SHA-256 / 512** authentication: provide values for **Username** and **Password** fields.

- **AWS** authentication: Provide values for **AWS Access Key ID** and **AWS Secret Key** fields, and optionally for the **AWS Authorization Identity** field.

- **Client Certificate** authentication: provide values for the **SSL Client Key** and **SSL Client Certificate** fields.

forstisabella · 2024-03-25T16:54:14Z

src/connections/destinations/catalog/kafka/index.md

+Authentication and Encryption settings for Kafka depend on the way your cluster is configured. You may need the assistance of someone technical to provide values for the following configuration Settings:  
+
+5. On the Settings tab, provide values for the **Client ID**, **Brokers** and **Authentication Mechanism** Setting fields. 
+6. Populate fields for your selected **Authentication Mechanism**:  


Suggested change

6. Populate fields for your selected **Authentication Mechanism**:

6. Populate fields for your selected authentication mechanism:

forstisabella · 2024-03-25T16:54:18Z

src/connections/destinations/catalog/kafka/index.md

+
+### Configure the Kafka Destination
+
+Authentication and Encryption settings for Kafka depend on the way your cluster is configured. You may need the assistance of someone technical to provide values for the following configuration Settings:  


Suggested change

Authentication and Encryption settings for Kafka depend on the way your cluster is configured. You may need the assistance of someone technical to provide values for the following configuration Settings:

The way you configured your cluster informs the authentication and encryption settings you'll need to set up for Kafka. You may need the assistance of someone technical to provide values for the following configuration Settings:

joe-ayoub-segment · 2024-03-26T11:52:21Z

hi @forstisabella I've applied all the suggestions.

src/connections/destinations/catalog/actions-kafka/index.md

forstisabella

lgtm - waiting to merge until I can fix the ordering under the different subheadings in the procedure

github-actions · 2024-03-27T22:15:40Z

Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site.

adding Kafka Destination docs

371fc8f

joe-ayoub-segment requested a review from a team as a code owner March 25, 2024 14:20

joe-ayoub-segment requested review from forstisabella and removed request for a team March 25, 2024 14:20

spelling corrections

19d8576

forstisabella reviewed Mar 25, 2024

View reviewed changes

forstisabella requested changes Mar 25, 2024

View reviewed changes

forstisabella added the new-integration Added a new source or destination label Mar 25, 2024

joe-ayoub-segment added 2 commits March 26, 2024 11:37

changing folder name

137cf72

applying suggestions

4f67982

adding ID

2be297b

forstisabella self-requested a review March 26, 2024 15:48

forstisabella reviewed Mar 26, 2024

View reviewed changes

src/connections/destinations/catalog/actions-kafka/index.md Outdated Show resolved Hide resolved

Update src/connections/destinations/catalog/actions-kafka/index.md

1764255

forstisabella self-requested a review March 26, 2024 17:09

forstisabella approved these changes Mar 26, 2024

View reviewed changes

reset numbering

9f330e5

forstisabella merged commit 9758233 into develop Mar 27, 2024
4 checks passed

forstisabella deleted the kafka branch March 27, 2024 22:15

forstisabella mentioned this pull request Apr 2, 2024

Re-run catalog for kafka and linkedin conversions api destinations #6335

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding Kafka Destination docs #6280

adding Kafka Destination docs #6280

joe-ayoub-segment commented Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

joe-ayoub-segment Mar 26, 2024

forstisabella Mar 26, 2024

forstisabella left a comment

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

forstisabella Mar 25, 2024

joe-ayoub-segment commented Mar 26, 2024

forstisabella left a comment

github-actions bot commented Mar 27, 2024


		[Kafka](https://kafka.apache.org/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners){:target="_blank”} provides a highly scalable and fault-tolerant messaging system that enables real-time data processing and stream processing at scale. When integrated with Segment, Kafka serves as a powerful backbone for managing and processing event data collected by Segment, allowing businesses to efficiently ingest, route, and analyze data across various applications and systems in real time.

		This destination is maintained by Segment.

		1. From your workspace's [Destination catalog page](https://app.segment.com/goto-my-workspace/destinations/catalog){:target="_blank”} search for "Kafka"
		2. Select the "Kafka" tile and click Add Destination

	3. Select an existing Source to connect to Kafka.
	3. Select an existing source to connect to Kafka.

	4. Give your Kafka Destination a name.
	4. Enter a name for your Kafka destination.

	8. Save your changes before proceeding to the next step.
	8. Save your changes and proceed to Configure the Send Action .

	7. Optionally populate the SSL Certificate Authority field.
	7. Populate the SSL Certificate Authority field, if necessary.

	6. Populate fields for your selected Authentication Mechanism:
	6. Populate fields for your selected authentication mechanism:


		### Configure the Kafka Destination

		Authentication and Encryption settings for Kafka depend on the way your cluster is configured. You may need the assistance of someone technical to provide values for the following configuration Settings:

	Authentication and Encryption settings for Kafka depend on the way your cluster is configured. You may need the assistance of someone technical to provide values for the following configuration Settings:
	The way you configured your cluster informs the authentication and encryption settings you'll need to set up for Kafka. You may need the assistance of someone technical to provide values for the following configuration Settings:

adding Kafka Destination docs #6280

adding Kafka Destination docs #6280

Conversation

joe-ayoub-segment commented Mar 25, 2024

Proposed changes

Merge timing

Related issues (optional)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

forstisabella left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

joe-ayoub-segment commented Mar 26, 2024

forstisabella left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 27, 2024