Add AWS MSK Routine Load docs in EN/ZH/JA#3520
Merged
liaoxin01 merged 3 commits intoapache:masterfrom Apr 10, 2026
Merged
Conversation
This was referenced Apr 6, 2026
liaoxin01
pushed a commit
to apache/doris
that referenced
this pull request
Apr 8, 2026
### What problem does this PR solve?
**_Overview_**:
This PR adds AWS MSK IAM authentication for Kafka Routine Load in Apache
Doris. You can connect to Amazon MSK using IAM credentials (including
Assume Role and cross-account) with SASL_SSL and OAUTHBEARER.
**_What It Solves_**:
1. Consume AWS MSK data from Doris via Routine Load.
2. Support three credential modes: explicit AK/SK, same-account Instance
Profile Assume Role, and cross-account AK/SK Assume Role.
3. Align with AWS MSK IAM (SigV4-signed OAUTHBEARER tokens).
**_SQL Examples_**
1. MSK IAM with explicit Access Key and Secret Key (same account)
```
CREATE ROUTINE LOAD my_msk_load ON my_db.my_table
COLUMNS (id, name, dt)
PROPERTIES (
"desired_concurrent_number" = "2",
"max_error_number" = "1000"
)
FROM KAFKA
(
"kafka_broker_list" = "b-1.xxx.kafka.us-east-1.amazonaws.com:9098,b-2.xxx.kafka.us-east-1.amazonaws.com:9098",
"kafka_topic" = "my-topic",
"property.security.protocol" = "SASL_SSL",
"property.sasl.mechanism" = "OAUTHBEARER",
"aws.region" = "us-east-1",
"aws.access_key" = "XXX",
"aws.secret_key" = "XXX"
);
```
2. MSK IAM with Assume Role (e.g. EC2 Instance Profile, same account)
```
CREATE ROUTINE LOAD my_msk_load ON my_db.my_table
COLUMNS (id, name, dt)
PROPERTIES (
"desired_concurrent_number" = "2"
)
FROM KAFKA
(
"kafka_broker_list" = "b-1.xxx.kafka.us-east-1.amazonaws.com:9098",
"kafka_topic" = "my-topic",
"property.security.protocol" = "SASL_SSL",
"property.sasl.mechanism" = "OAUTHBEARER",
"aws.region" = "us-east-1",
"aws.credentials_provider" = "xxx",
"aws.role_arn" = "arn:aws:iam::123456789012:role/MyMSKConsumerRole"
);
```
3. MSK IAM with cross-account Assume Role (AK/SK of account B to assume
role in account A)
```
CREATE ROUTINE LOAD my_msk_load ON my_db.my_table
COLUMNS (id, name, dt)
PROPERTIES (
"desired_concurrent_number" = "2"
)
FROM KAFKA
(
"kafka_broker_list" = "b-1.xxx.kafka.us-east-1.amazonaws.com:9098",
"kafka_topic" = "my-topic",
"property.security.protocol" = "SASL_SSL",
"property.sasl.mechanism" = "OAUTHBEARER",
"aws.region" = "us-east-1",
"aws.role_arn" = "arn:aws:iam::111111111111:role/CrossAccountMSKRole",
"aws.access_key" = "XXX",
"aws.secret_key" = "XXX"
);
```
Validation rules (FE): When any aws.* property is set, aws.region is
required, and property.security.protocol must be SASL_SSL and
property.sasl.mechanism must be OAUTHBEARER. If you use explicit
credentials, both aws.access.key and aws.secret.key must be set
together.
doc pr:apache/doris-website#3520
github-actions Bot
pushed a commit
to apache/doris
that referenced
this pull request
Apr 8, 2026
### What problem does this PR solve?
**_Overview_**:
This PR adds AWS MSK IAM authentication for Kafka Routine Load in Apache
Doris. You can connect to Amazon MSK using IAM credentials (including
Assume Role and cross-account) with SASL_SSL and OAUTHBEARER.
**_What It Solves_**:
1. Consume AWS MSK data from Doris via Routine Load.
2. Support three credential modes: explicit AK/SK, same-account Instance
Profile Assume Role, and cross-account AK/SK Assume Role.
3. Align with AWS MSK IAM (SigV4-signed OAUTHBEARER tokens).
**_SQL Examples_**
1. MSK IAM with explicit Access Key and Secret Key (same account)
```
CREATE ROUTINE LOAD my_msk_load ON my_db.my_table
COLUMNS (id, name, dt)
PROPERTIES (
"desired_concurrent_number" = "2",
"max_error_number" = "1000"
)
FROM KAFKA
(
"kafka_broker_list" = "b-1.xxx.kafka.us-east-1.amazonaws.com:9098,b-2.xxx.kafka.us-east-1.amazonaws.com:9098",
"kafka_topic" = "my-topic",
"property.security.protocol" = "SASL_SSL",
"property.sasl.mechanism" = "OAUTHBEARER",
"aws.region" = "us-east-1",
"aws.access_key" = "XXX",
"aws.secret_key" = "XXX"
);
```
2. MSK IAM with Assume Role (e.g. EC2 Instance Profile, same account)
```
CREATE ROUTINE LOAD my_msk_load ON my_db.my_table
COLUMNS (id, name, dt)
PROPERTIES (
"desired_concurrent_number" = "2"
)
FROM KAFKA
(
"kafka_broker_list" = "b-1.xxx.kafka.us-east-1.amazonaws.com:9098",
"kafka_topic" = "my-topic",
"property.security.protocol" = "SASL_SSL",
"property.sasl.mechanism" = "OAUTHBEARER",
"aws.region" = "us-east-1",
"aws.credentials_provider" = "xxx",
"aws.role_arn" = "arn:aws:iam::123456789012:role/MyMSKConsumerRole"
);
```
3. MSK IAM with cross-account Assume Role (AK/SK of account B to assume
role in account A)
```
CREATE ROUTINE LOAD my_msk_load ON my_db.my_table
COLUMNS (id, name, dt)
PROPERTIES (
"desired_concurrent_number" = "2"
)
FROM KAFKA
(
"kafka_broker_list" = "b-1.xxx.kafka.us-east-1.amazonaws.com:9098",
"kafka_topic" = "my-topic",
"property.security.protocol" = "SASL_SSL",
"property.sasl.mechanism" = "OAUTHBEARER",
"aws.region" = "us-east-1",
"aws.role_arn" = "arn:aws:iam::111111111111:role/CrossAccountMSKRole",
"aws.access_key" = "XXX",
"aws.secret_key" = "XXX"
);
```
Validation rules (FE): When any aws.* property is set, aws.region is
required, and property.security.protocol must be SASL_SSL and
property.sasl.mechanism must be OAUTHBEARER. If you use explicit
credentials, both aws.access.key and aws.secret.key must be set
together.
doc pr:apache/doris-website#3520
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Versions
Languages
Docs Checklist