Skip to content
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
wants to merge 6 commits into
base: 4.1
Choose a base branch
from

Conversation

wuqingjuntg
Copy link

No description provided.

@wuqingjuntg wuqingjuntg changed the base branch from 3.9.3 to 4.1.o August 6, 2024 17:50
@@ -25,8 +25,9 @@ If the source cluster is configured for SSL or SASL protocols, you need to provi
* 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`.
The following are generic configurations required for admin, producer and consumer. To supply the configuration for the corresponding component, replace `<prefix>` with `source.admin`, `producer`, or `consumer`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you tried it?

  • Are source.admin, producer, or consumer all required?
  • Why admin requires source prefix but others are not?
  • How about using source.cluster?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I should have mentioned this earlier:

  • We already have a separate instructions on how to set up security (SSL), so user can just follow that instruction to set up SSL, by gadmin enabling a couple of flags, setting certificates etc.;
  • This example is simply about avro/mm2, so let's try to make this example as simple as possible;
  • This document was provided when SSL is not supported; now given SSL is already supported, we can just recommend user to use SSL if they are concerned about security;
  • All these settings are covered by our current regress test, e.g., cqrs_cluster 101.
  • I would recommend to remove all the wording including SASL from the document. We have a plan to support SASL, but we haven't implemented/supported it yet.

Let me know your thoughts.
Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All these settings are covered by our current regress test, e.g., cqrs_cluster 101.

  • cqrs_cluster 101 is for CRR with SSL, not loading from external Kafka. The SSL setting should be different because the CRR SSL setting is auto-generated.
  • In the auto-generated CRR config you wrote, it is using source.cluster.ssl instead of source.admin, producer or consumer

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • No. cqrs_cluster 101 includes two test cases: test1.sh and test2.sh. test1.sh is for generic mm2; test2.sh is for crr.
  • When I designed SSL for MM2/CRR, connector_manager was used to set up ssl configuration settings to improve the usability.
  • You seemed to ask similar question when you reviewed the SSL PR, here is one of the comments: https://github.com/tigergraph/cqrs/pull/3001/files#r1432225187 . Basically, Kafka(KafkaConn) maintains precedence of SSL settings: (source or target).cluster.ssl > admin/producer/consumer.ssl etc.. In the design, I just made it simple: all admin/producer/consumer share the same SSL settings to make things simple.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically, Kafka(KafkaConn) maintains precedence of SSL settings: (source or target).cluster.ssl > admin/producer/consumer.ssl etc.

  • Have we explained this to the user? That's why I'm asking to improve the doc.
  • Even if we use admin, consumer and producer separately, there's still some mistakes in the doc: why source.admin but not no source. for consumer and producer?

Comment on lines 25 to 28
* 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`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why remove them?

}
----

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[]
Copy link
Contributor

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.

  • SSL for internal Kafka
  • SSL for CRR
  • SSL for loading from external Kafka

They should belong to 3 different categories(under 3 different pages) instead of putting them together.

Copy link
Author

@wuqingjuntg wuqingjuntg Aug 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Let's clarify here. We're not going to cover SSL for CRR here right?
  • For internal and external Kafka, I don't see major difference. The "internal" Kafka is set up for testing loading from regular Kafka cluster including external Kafka. Let me know if there's any understanding gap. We can have a short discussion in Tuesday's meeting and get consensus about this with the team. ( At the moment I still have a couple of JIRA tickets to handle, which also have high priorities).
  • I am removing the SASL and the SASL/SSL parameters, because: without SSL, SASL is not secured. SASL is authentication method, but without encryption, the connection is not secured. So we should simply recommend the users to enable regular SSL to secure the connection between Kafka clusters. User doesn't need to use both SASL + SSL. SSL is enough. And we didn't officially support SASL yet.
  • My suggestion is that, for all the configuration/settings in the DOC, we should have already supported the feature and also have test cases covering those configs.

cc @arunramasami , FYI. Any comments regarding this DOC change I am making?

@victorleeTG victorleeTG changed the title DOC-2085 fix(dataloading): Revising data loading relevant documentation; DOC-2085 fix(dataloading): improve doc for Load from External Kafka (3.9?-4.1) Oct 18, 2024
@victorleeTG victorleeTG added the doc improv Improvements or additions to documentation label Oct 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc improv Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants