You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@kafka.apache.org by GitBox <gi...@apache.org> on 2022/11/29 21:33:46 UTC
[GitHub] [kafka] joel-hamill opened a new pull request, #12921: MINOR: fix config syntax
joel-hamill opened a new pull request, #12921:
URL: https://github.com/apache/kafka/pull/12921
*More detailed description of your change,
if necessary. The PR title and PR message become
the squashed commit message, so use a separate
comment to ping reviewers.*
*Summary of testing strategy (including rationale)
for the feature or bug fix. Unit and/or integration
tests are expected for any behaviour change and
system tests should be considered for larger changes.*
### Committer Checklist (excluded from commit message)
- [ ] Verify design and implementation
- [ ] Verify test coverage and CI build status
- [ ] Verify documentation (including upgrade notes)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joel-hamill commented on pull request #12921: MINOR: fix config syntax
Posted by GitBox <gi...@apache.org>.
joel-hamill commented on PR #12921:
URL: https://github.com/apache/kafka/pull/12921#issuecomment-1331343528
cc @guozhangwang
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] jsancio commented on a diff in pull request #12921: MINOR; Fix config documentation formatting
Posted by GitBox <gi...@apache.org>.
jsancio commented on code in PR #12921:
URL: https://github.com/apache/kafka/pull/12921#discussion_r1035377520
##########
clients/src/main/java/org/apache/kafka/common/config/internals/BrokerSecurityConfigs.java:
##########
@@ -61,10 +61,10 @@ public class BrokerSecurityConfigs {
public static final String SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES_DOC = "A list of rules for mapping from principal " +
"names to short names (typically operating system usernames). The rules are evaluated in order and the " +
"first rule that matches a principal name is used to map it to a short name. Any later rules in the list are " +
- "ignored. By default, principal names of the form {username}/{hostname}@{REALM} are mapped to {username}. " +
- "For more details on the format please see <a href=\"#security_authz\"> security authorization and acls</a>. " +
- "Note that this configuration is ignored if an extension of KafkaPrincipalBuilder is provided by the " +
- "<code>" + PRINCIPAL_BUILDER_CLASS_CONFIG + "</code> configuration.";
+ "ignored. By default, principal names of the form <code>{username}/{hostname}@{REALM}</code> are mapped +
+ "to <code>{username}</code>. For more details on the format please see <a href=\"#security_authz\"> +
+ "security authorization and acls</a>. Note that this configuration is ignored if an extension of +
Review Comment:
These 3 lines are missing an end quote. E.g.
```java
"ignored. By default, principal names of the form <code>{username}/{hostname}@{REALM}</code> are mapped " +
"to <code>{username}</code>. For more details on the format please see <a href=\"#security_authz\"> " +
"security authorization and acls</a>. Note that this configuration is ignored if an extension of " +
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] joel-hamill commented on pull request #12921: MINOR: fix config syntax
Posted by GitBox <gi...@apache.org>.
joel-hamill commented on PR #12921:
URL: https://github.com/apache/kafka/pull/12921#issuecomment-1331430529
@jsancio updated
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] jsancio commented on a diff in pull request #12921: MINOR; Fix config documentation formatting
Posted by GitBox <gi...@apache.org>.
jsancio commented on code in PR #12921:
URL: https://github.com/apache/kafka/pull/12921#discussion_r1035377520
##########
clients/src/main/java/org/apache/kafka/common/config/internals/BrokerSecurityConfigs.java:
##########
@@ -61,10 +61,10 @@ public class BrokerSecurityConfigs {
public static final String SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES_DOC = "A list of rules for mapping from principal " +
"names to short names (typically operating system usernames). The rules are evaluated in order and the " +
"first rule that matches a principal name is used to map it to a short name. Any later rules in the list are " +
- "ignored. By default, principal names of the form {username}/{hostname}@{REALM} are mapped to {username}. " +
- "For more details on the format please see <a href=\"#security_authz\"> security authorization and acls</a>. " +
- "Note that this configuration is ignored if an extension of KafkaPrincipalBuilder is provided by the " +
- "<code>" + PRINCIPAL_BUILDER_CLASS_CONFIG + "</code> configuration.";
+ "ignored. By default, principal names of the form <code>{username}/{hostname}@{REALM}</code> are mapped +
+ "to <code>{username}</code>. For more details on the format please see <a href=\"#security_authz\"> +
+ "security authorization and acls</a>. Note that this configuration is ignored if an extension of +
Review Comment:
These 3 lines are missing and end quote. E.g.
```java
"ignored. By default, principal names of the form <code>{username}/{hostname}@{REALM}</code> are mapped " +
"to <code>{username}</code>. For more details on the format please see <a href=\"#security_authz\"> " +
"security authorization and acls</a>. Note that this configuration is ignored if an extension of " +
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] jsancio commented on a diff in pull request #12921: MINOR: fix config syntax
Posted by GitBox <gi...@apache.org>.
jsancio commented on code in PR #12921:
URL: https://github.com/apache/kafka/pull/12921#discussion_r1035335635
##########
clients/src/main/java/org/apache/kafka/common/config/internals/BrokerSecurityConfigs.java:
##########
@@ -61,10 +61,10 @@ public class BrokerSecurityConfigs {
public static final String SASL_KERBEROS_PRINCIPAL_TO_LOCAL_RULES_DOC = "A list of rules for mapping from principal " +
"names to short names (typically operating system usernames). The rules are evaluated in order and the " +
"first rule that matches a principal name is used to map it to a short name. Any later rules in the list are " +
- "ignored. By default, principal names of the form {username}/{hostname}@{REALM} are mapped to {username}. " +
- "For more details on the format please see <a href=\"#security_authz\"> security authorization and acls</a>. " +
- "Note that this configuration is ignored if an extension of KafkaPrincipalBuilder is provided by the " +
- "<code>" + PRINCIPAL_BUILDER_CLASS_CONFIG + "</code> configuration.";
+ "ignored. By default, principal names of the form "<code>" + {username}/{hostname}@{REALM} "</code>" + are mapped +
+ "to "<code>" + {username}+ "</code>". For more details on the format please see <a href=\"#security_authz\"> +
+ "security authorization and acls</a>. Note that this configuration is ignored if an extension of +
+ "KafkaPrincipalBuilder is provided by the <code>" + PRINCIPAL_BUILDER_CLASS_CONFIG + "</code> configuration.";
Review Comment:
`KafkaPrincipalBuilder` should be surrounded by `<code></code>`.
##########
streams/src/main/java/org/apache/kafka/streams/StreamsConfig.java:
##########
@@ -481,7 +481,7 @@ public class StreamsConfig extends AbstractConfig {
@SuppressWarnings("WeakerAccess")
public static final String CLIENT_ID_CONFIG = CommonClientConfigs.CLIENT_ID_CONFIG;
private static final String CLIENT_ID_DOC = "An ID prefix string used for the client IDs of internal consumer, producer and restore-consumer," +
- " with pattern '<client.id>-StreamThread-<threadSequenceNumber>-<consumer|producer|restore-consumer>'.";
+ " with pattern "<code>" + <client.id>-StreamThread-<threadSequenceNumber>-<consumer|producer|restore-consumer> + "</code>.";
Review Comment:
It should be something like:
```java
" with pattern <code><client.id>-StreamThread-<threadSequenceNumber$gt;-<consumer|producer|restore-consumer></code>.";
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [kafka] jsancio merged pull request #12921: MINOR: Fix config documentation formatting
Posted by GitBox <gi...@apache.org>.
jsancio merged PR #12921:
URL: https://github.com/apache/kafka/pull/12921
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: jira-unsubscribe@kafka.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org