Skip to content

Commit 6472eb8

Browse files
committed
pipeline: input: kafka: adjust details for AWS MSK IAM
Signed-off-by: Eduardo Silva <[email protected]>
1 parent d87adff commit 6472eb8

File tree

1 file changed

+17
-9
lines changed

1 file changed

+17
-9
lines changed

pipeline/inputs/kafka.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,15 +20,6 @@ This plugin uses the official [librdkafka C library](https://github.com/edenhill
2020
| `rdkafka.{property}` | `{property}` can be any [librdkafka properties](https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md) | _none_ |
2121
| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2222

23-
24-
## Configuration parameters for AWS MSK clusters based on IAM authentication
25-
26-
| Property | Description | Type | Required |
27-
|----------|-------------|------|----------|
28-
| `aws_msk_iam` | Enable AWS MSK IAM authentication | Boolean | No (default: false) |
29-
| `aws_msk_iam_cluster_arn` | Full ARN of the MSK cluster for region extraction | String | Yes (when `aws_msk_iam` is true) |
30-
31-
3223
## Get started
3324

3425
To subscribe to or collect messages from Apache Kafka, run the plugin from the command line or through the configuration file as shown below.
@@ -174,6 +165,23 @@ If you are compiling Fluent Bit from source, ensure the following requirements a
174165
| `aws_msk_iam` | Enable AWS MSK IAM authentication | Boolean | No (default: false) |
175166
| `aws_msk_iam_cluster_arn` | Full ARN of the MSK cluster for region extraction | String | Yes (if `aws_msk_iam` is true)|
176167

168+
169+
### Configuration Example
170+
171+
```yaml
172+
pipeline:
173+
inputs:
174+
- name: kafka
175+
brokers: my-cluster.abcdef.c1.kafka.us-east-1.amazonaws.com:9098
176+
topics: my-topic
177+
aws_msk_iam: true
178+
aws_msk_iam_cluster_arn: arn:aws:kafka:us-east-1:123456789012:cluster/my-cluster/abcdef-1234-5678-9012-abcdefghijkl-s3
179+
180+
outputs:
181+
- name: stdout
182+
match: '*'
183+
```
184+
177185
### Example AWS IAM Policy
178186
179187
> **Note:** IAM policies and permissions can be complex and may vary depending on your organization's security requirements. If you are unsure about the correct permissions or best practices, please consult with your AWS administrator or an AWS expert who is familiar with MSK and IAM security.

0 commit comments

Comments
 (0)