NIFI-6083 - Improving documentation for Kafka Service Name property

This closes #3365.

Signed-off-by: Bryan Bende <bbende@apache.org>
This commit is contained in:
pushpavanthar 2019-03-12 01:08:32 +05:30 committed by Bryan Bende
parent 160ade9f9d
commit 98ca28d50d
No known key found for this signature in database
GPG Key ID: A0DDA9ED50711C39
6 changed files with 11 additions and 6 deletions

View File

@ -262,7 +262,7 @@ public class ReportLineageToAtlas extends AbstractReportingTask {
static final PropertyDescriptor KAFKA_KERBEROS_SERVICE_NAME = new PropertyDescriptor.Builder()
.name("kafka-kerberos-service-name")
.displayName("Kafka Kerberos Service Name")
.description("The Kerberos principal name that Kafka runs for Atlas notification." +
.description("The service name that matches the primary name of the Kafka server configured in the broker JAAS file." +
" This can be defined either in Kafka's JAAS config or in Kafka's config." +
" Corresponds to Kafka's 'security.protocol' property." +
" It is ignored unless one of the SASL options of the <Security Protocol> are selected.")

View File

@ -92,7 +92,8 @@ final class KafkaProcessorUtils {
static final PropertyDescriptor JAAS_SERVICE_NAME = new PropertyDescriptor.Builder()
.name("sasl.kerberos.service.name")
.displayName("Kerberos Service Name")
.description("The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. "
.description("The service name that matches the primary name of the Kafka server configured in the broker JAAS file."
+ "This can be defined either in Kafka's JAAS config or in Kafka's config. "
+ "Corresponds to Kafka's 'security.protocol' property."
+ "It is ignored unless one of the SASL options of the <Security Protocol> are selected.")
.required(false)

View File

@ -92,7 +92,8 @@ final class KafkaProcessorUtils {
static final PropertyDescriptor JAAS_SERVICE_NAME = new PropertyDescriptor.Builder()
.name("sasl.kerberos.service.name")
.displayName("Kerberos Service Name")
.description("The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. "
.description("The service name that matches the primary name of the Kafka server configured in the broker JAAS file."
+ "This can be defined either in Kafka's JAAS config or in Kafka's config. "
+ "Corresponds to Kafka's 'security.protocol' property."
+ "It is ignored unless one of the SASL options of the <Security Protocol> are selected.")
.required(false)

View File

@ -90,7 +90,8 @@ final class KafkaProcessorUtils {
static final PropertyDescriptor KERBEROS_PRINCIPLE = new PropertyDescriptor.Builder()
.name("sasl.kerberos.service.name")
.displayName("Kerberos Service Name")
.description("The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. "
.description("The service name that matches the primary name of the Kafka server configured in the broker JAAS file."
+ "This can be defined either in Kafka's JAAS config or in Kafka's config. "
+ "Corresponds to Kafka's 'security.protocol' property."
+ "It is ignored unless one of the SASL options of the <Security Protocol> are selected.")
.required(false)

View File

@ -92,7 +92,8 @@ final class KafkaProcessorUtils {
static final PropertyDescriptor JAAS_SERVICE_NAME = new PropertyDescriptor.Builder()
.name("sasl.kerberos.service.name")
.displayName("Kerberos Service Name")
.description("The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. "
.description("The service name that matches the primary name of the Kafka server configured in the broker JAAS file."
+ "This can be defined either in Kafka's JAAS config or in Kafka's config. "
+ "Corresponds to Kafka's 'security.protocol' property."
+ "It is ignored unless one of the SASL options of the <Security Protocol> are selected.")
.required(false)

View File

@ -92,7 +92,8 @@ final class KafkaProcessorUtils {
static final PropertyDescriptor JAAS_SERVICE_NAME = new PropertyDescriptor.Builder()
.name("sasl.kerberos.service.name")
.displayName("Kerberos Service Name")
.description("The Kerberos principal name that Kafka runs as. This can be defined either in Kafka's JAAS config or in Kafka's config. "
.description("The service name that matches the primary name of the Kafka server configured in the broker JAAS file."
+ "This can be defined either in Kafka's JAAS config or in Kafka's config. "
+ "Corresponds to Kafka's 'security.protocol' property."
+ "It is ignored unless one of the SASL options of the <Security Protocol> are selected.")
.required(false)