-
Notifications
You must be signed in to change notification settings - Fork 24
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
DOC-2085 fix(dataloading): improve doc for Load from External Kafka (3.9?-4.1) #491
Open
wuqingjuntg
wants to merge
6
commits into
4.1
Choose a base branch
from
DOC-2085
base: 4.1
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
ea27181
Revising documentation about data-loading.
wuqingjuntg adb8200
To make it simple, let's support SSL only, and not SASL(including SAS…
wuqingjuntg 6de9366
sql -> gsql
wuqingjuntg a52c0ce
Addressing comments.
wuqingjuntg 8142602
Merge branch '4.1.o' into DOC-2085
wuqingjuntg 3101fbb
Resolving code review comments.
wuqingjuntg File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,8 @@ | ||
connector.class=org.apache.kafka.connect.mirror.MirrorSourceConnector | ||
source.cluster.alias=hello | ||
target.cluster.alias=world | ||
source.cluster.bootstrap.servers=source.kafka.server:9092 | ||
target.cluster.bootstrap.servers=localhost:30002 | ||
source.cluster.bootstrap.servers=<source.broker1:port,source.broker2:port,...> | ||
target.cluster.bootstrap.servers=<local.broker1:port,local.broker2:port,...> | ||
source->target.enabled=true | ||
topics=avro-without-registry-topic | ||
replication.factor=1 | ||
|
@@ -18,41 +18,10 @@ emit.heartbeats.interval.seconds=5 | |
world.scheduled.rebalance.max.delay.ms=35000 | ||
key.converter=org.apache.kafka.connect.converters.ByteArrayConverter | ||
header.converter=org.apache.kafka.connect.converters.ByteArrayConverter | ||
value.converter=com.tigergraph.kafka.connect.converters.TigerGraphAvroConverterWithoutSchemaRegistry | ||
|
||
producer.security.protocol=SASL_SSL | ||
producer.sasl.mechanism=GSSAPI | ||
producer.sasl.kerberos.service.name=kafka | ||
producer.sasl.jaas.config=com.sun.security.auth.module.Krb5LoginModule required useKeyTab=true storeKey=true keyTab=\"/path/to/kafka-producer.keytab\" principal=\"[email protected]\"; | ||
producer.ssl.endpoint.identification.algorithm= | ||
producer.ssl.keystore.location=/path/to/client.keystore.jks | ||
producer.ssl.keystore.password=****** | ||
producer.ssl.key.password=****** | ||
producer.ssl.truststore.location=/path/to/client.truststore.jks | ||
producer.ssl.truststore.password=****** | ||
|
||
consumer.security.protocol=SASL_SSL | ||
consumer.sasl.mechanism=GSSAPI | ||
consumer.sasl.kerberos.service.name=kafka | ||
consumer.sasl.jaas.config=com.sun.security.auth.module.Krb5LoginModule required useKeyTab=true storeKey=true keyTab=\"/path/to/kafka-consumer.keytab\" principal=\"[email protected]\"; | ||
consumer.ssl.endpoint.identification.algorithm= | ||
consumer.ssl.keystore.location=/path/to/client.keystore.jks | ||
consumer.ssl.keystore.password=****** | ||
consumer.ssl.key.password=****** | ||
consumer.ssl.truststore.location=/path/to/client.truststore.jks | ||
consumer.ssl.truststore.password=****** | ||
|
||
source.admin.security.protocol=SASL_SSL | ||
source.admin.sasl.mechanism=GSSAPI | ||
source.admin.sasl.kerberos.service.name=kafka | ||
source.admin.sasl.jaas.config=com.sun.security.auth.module.Krb5LoginModule required useKeyTab=true storeKey=true keyTab=\"/path/to/kafka-admin.keytab\" principal=\"[email protected]\"; | ||
source.admin.ssl.endpoint.identification.algorithm= | ||
source.admin.ssl.keystore.location=/path/to/client.keystore.jks | ||
source.admin.ssl.keystore.password=****** | ||
source.admin.ssl.key.password=****** | ||
source.admin.ssl.truststore.location=/path/to/client.truststore.jks | ||
source.admin.ssl.truststore.password=****** | ||
transforms=TigerGraphAvroTransform | ||
transforms.TigerGraphAvroTransform.type=com.tigergraph.kafka.connect.transformations.TigergraphAvroWithoutSchemaRegistryTransformation | ||
transforms.TigerGraphAvroTransform.errors.tolerance=none | ||
|
||
[connector_1] | ||
name=avro-test-without-registry | ||
tasks.max=10 | ||
tasks.max=10 |
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,61 +13,12 @@ To configure the data source object, the minimum requirement is the address of t | |
.Data source configuration for external Kafka | ||
---- | ||
{ | ||
"type": "mirrormaker", | ||
"source.cluster.bootstrap.servers": "<broker_addrs>" | ||
"type": "mirrormaker", | ||
"source.cluster.bootstrap.servers": "<broker_addrs>" | ||
} | ||
---- | ||
|
||
If the source cluster is configured for SSL or SASL protocols, you need to provide the following SSL/SASL credentials in order to communicate with the source cluster. | ||
|
||
* If the source cluster uses SASL, you need to upload the keytab of each Kerberos principal to every node of your TigerGraph cluster at the same absolute path. | ||
* If the source cluster uses SSL, see our documentation xref:tigergraph-server:data-loading:kafka-ssl-security-guide.adoc[] | ||
* If the source cluster uses SASL *and* SSL, you need to upload the keytab of each Kerberos principal, as well as the key store and truststore to every node of your TigerGraph cluster. | ||
Each file must be at the same absolute path on all nodes. | ||
|
||
The following configurations are required for admin, producer and consumer. To supply the configuration for the corresponding component, replace `<prefix>` with `source.admin`, `producer`, or `consumer`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why remove them? |
||
For example, to specify `GSSAPI` as the SASL mechanism for consumer, include `"consumer.sasl.mecahnism": "GSSAPI"` in the data source configuration. | ||
|
||
[%header,cols="1,2"] | ||
|=== | ||
| Field | Description | ||
|
||
| <prefix>.security.protocol | ||
| Protocol used to communicate with brokers. | ||
Valid values are: `PLAINTEXT`, `SSL, `SASL_PLAINTEXT`, `SASL_SSL`. | ||
The default is `PLAINTEXT`. | ||
|
||
| <prefix>.sasl.mechanism | ||
| SASL mechanism used for client connections. | ||
This may be any mechanism for which a security provider is available. GSSAPI is the default mechanism. | ||
|
||
| <prefix>.sasl.kerberos.service.name | ||
| The Kerberos principal name used by your Kafka brokers. | ||
This could be defined in either JAAS configuration or Kafka’s configuration. | ||
|
||
| <prefix>.sasl.jaas.config | ||
| JAAS login context parameters for SASL connections in the format used by JAAS configuration files. | ||
See https://docs.oracle.com/javase/8/docs/technotes/guides/security/jgss/tutorials/LoginConfigFile.html[JAAS Login Configuration File] for details. | ||
|
||
| <prefix>.ssl.endpoint.identification.algorithm | ||
| The endpoint identification algorithm used to validate server hostname in the server certificate. Default is `https`. | ||
If the value is set to an empty string, this will disable server host name verification. | ||
|
||
| <prefix>.ssl.keystore.location | ||
| The location of the key store file. | ||
|
||
| <prefix>.ssl.keystore.password | ||
| The password of the key store file. | ||
|
||
| <prefix>.ssl.key.password | ||
| The password of the private key in the key store file or the PEM key specified in `ssl.keystore.key`. | ||
|
||
| <prefix>.ssl.truststore.location | ||
| The location of the trust store file. | ||
|
||
| <prefix>.ssl.truststore.password | ||
| The password for the trust store file. | ||
|=== | ||
|
||
If there is a https://docs.confluent.io/platform/current/schema-registry/index.html[schema registry service] containing the record schema of the source topic, please add it to the data source configuration: | ||
|
||
|
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://graphsql.atlassian.net/browse/DOC-1972?focusedCommentId=152682 see comment for
kafka-ssl-security-guide.adoc
.They should belong to 3 different categories(under 3 different pages) instead of putting them together.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cc @arunramasami , FYI. Any comments regarding this DOC change I am making?