NIFI-4600: This closes #2312. Added nifi-kafka-1-0-nar and nifi-kafka-1-0-processors modules
Signed-off-by: joewitt
- This Processor polls Apache Kafka
- for data using KafkaConsumer API available with Kafka 0.11.x. When a message is received
- from Kafka, the message will be deserialized using the configured Record Reader, and then
- written to a FlowFile by serializing the message with the configured Record Writer.
-
- The Security Protocol property allows the user to specify the protocol for communicating
- with the Kafka broker. The following sections describe each of the protocols in further detail.
-
- This option provides an unsecured connection to the broker, with no client authentication and no encryption.
- In order to use this option the broker must be configured with a listener of the form:
- Description
- Security Configuration:
- PLAINTEXT
-
- PLAINTEXT://host.name:port
-
-
- This option provides an encrypted connection to the broker, with optional client authentication. In order - to use this option the broker must be configured with a listener of the form: -
- SSL://host.name:port -- In addition, the processor must have an SSL Context Service selected. - -
- If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will - not be required to present a certificate. In this case, the SSL Context Service selected may specify only - a truststore containing the public key of the certificate authority used to sign the broker's key. -
-- If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. - In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to - a truststore as described above. -
-- This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this - option the broker must be configured with a listener of the form: -
- SASL_PLAINTEXT://host.name:port -- In addition, the Kerberos Service Name must be specified in the processor. - -
- If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The - JAAS configuration can be provided by specifying the java.security.auth.login.config system property in - NiFi's bootstrap.conf, such as: -
- java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf -- -
- An example of the JAAS config file would be the following: -
- KafkaClient { - com.sun.security.auth.module.Krb5LoginModule required - useKeyTab=true - storeKey=true - keyTab="/path/to/nifi.keytab" - serviceName="kafka" - principal="nifi@YOURREALM.COM"; - }; -- NOTE: The serviceName in the JAAS file must match the Kerberos Service Name in the processor. - -
- Alternatively, the JAAS - configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab - directly in the processor properties. This will dynamically create a JAAS configuration like above, and - will take precedence over the java.security.auth.login.config system property. -
-- If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but - the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would - be the following: -
- KafkaClient { - org.apache.kafka.common.security.plain.PlainLoginModule required - username="nifi" - password="nifi-password"; - }; -- -
- NOTE: It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit - the username and password unencrypted. -
-- NOTE: Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making - it visible to components in other NARs that may access the providers. There is currently a known issue - where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. -
-- This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this - option the broker must be configured with a listener of the form: -
- SASL_SSL://host.name:port -- -
- See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration - depending on the SASL mechanism (GSSAPI or PLAIN). -
-- See the SSL section for a description of how to configure the SSL Context Service based on the - ssl.client.auth property. -
- - - http://git-wip-us.apache.org/repos/asf/nifi/blob/00b11e82/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_11/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_11/additionalDetails.html b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_11/additionalDetails.html new file mode 100644 index 0000000..018a289 --- /dev/null +++ b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafkaRecord_0_11/additionalDetails.html @@ -0,0 +1,143 @@ + + + + + ++ This Processor polls Apache Kafka + for data using KafkaConsumer API available with Kafka 0.11.x. When a message is received + from Kafka, the message will be deserialized using the configured Record Reader, and then + written to a FlowFile by serializing the message with the configured Record Writer. +
+ + ++ The Security Protocol property allows the user to specify the protocol for communicating + with the Kafka broker. The following sections describe each of the protocols in further detail. +
++ This option provides an unsecured connection to the broker, with no client authentication and no encryption. + In order to use this option the broker must be configured with a listener of the form: +
+ PLAINTEXT://host.name:port ++ +
+ This option provides an encrypted connection to the broker, with optional client authentication. In order + to use this option the broker must be configured with a listener of the form: +
+ SSL://host.name:port ++ In addition, the processor must have an SSL Context Service selected. + +
+ If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will + not be required to present a certificate. In this case, the SSL Context Service selected may specify only + a truststore containing the public key of the certificate authority used to sign the broker's key. +
++ If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. + In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to + a truststore as described above. +
++ This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: +
+ SASL_PLAINTEXT://host.name:port ++ In addition, the Kerberos Service Name must be specified in the processor. + +
+ If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The + JAAS configuration can be provided by specifying the java.security.auth.login.config system property in + NiFi's bootstrap.conf, such as: +
+ java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf ++ +
+ An example of the JAAS config file would be the following: +
+ KafkaClient { + com.sun.security.auth.module.Krb5LoginModule required + useKeyTab=true + storeKey=true + keyTab="/path/to/nifi.keytab" + serviceName="kafka" + principal="nifi@YOURREALM.COM"; + }; ++ NOTE: The serviceName in the JAAS file must match the Kerberos Service Name in the processor. + +
+ Alternatively, the JAAS + configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab + directly in the processor properties. This will dynamically create a JAAS configuration like above, and + will take precedence over the java.security.auth.login.config system property. +
++ If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but + the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would + be the following: +
+ KafkaClient { + org.apache.kafka.common.security.plain.PlainLoginModule required + username="nifi" + password="nifi-password"; + }; ++ +
+ NOTE: It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit + the username and password unencrypted. +
++ NOTE: Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making + it visible to components in other NARs that may access the providers. There is currently a known issue + where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. +
++ This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: +
+ SASL_SSL://host.name:port ++ +
+ See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration + depending on the SASL mechanism (GSSAPI or PLAIN). +
++ See the SSL section for a description of how to configure the SSL Context Service based on the + ssl.client.auth property. +
+ + + http://git-wip-us.apache.org/repos/asf/nifi/blob/00b11e82/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/additionalDetails.html b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/additionalDetails.html deleted file mode 100644 index 760066d..0000000 --- a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_10/additionalDetails.html +++ /dev/null @@ -1,143 +0,0 @@ - - - - - -- This Processor polls Apache Kafka - for data using KafkaConsumer API available with Kafka 0.11.x. When a message is received - from Kafka, this Processor emits a FlowFile where the content of the FlowFile is the value - of the Kafka message. -
- - -- The Security Protocol property allows the user to specify the protocol for communicating - with the Kafka broker. The following sections describe each of the protocols in further detail. -
-- This option provides an unsecured connection to the broker, with no client authentication and no encryption. - In order to use this option the broker must be configured with a listener of the form: -
- PLAINTEXT://host.name:port -- -
- This option provides an encrypted connection to the broker, with optional client authentication. In order - to use this option the broker must be configured with a listener of the form: -
- SSL://host.name:port -- In addition, the processor must have an SSL Context Service selected. - -
- If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will - not be required to present a certificate. In this case, the SSL Context Service selected may specify only - a truststore containing the public key of the certificate authority used to sign the broker's key. -
-- If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. - In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to - a truststore as described above. -
-- This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this - option the broker must be configured with a listener of the form: -
- SASL_PLAINTEXT://host.name:port -- In addition, the Kerberos Service Name must be specified in the processor. - -
- If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The - JAAS configuration can be provided by specifying the java.security.auth.login.config system property in - NiFi's bootstrap.conf, such as: -
- java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf -- -
- An example of the JAAS config file would be the following: -
- KafkaClient { - com.sun.security.auth.module.Krb5LoginModule required - useKeyTab=true - storeKey=true - keyTab="/path/to/nifi.keytab" - serviceName="kafka" - principal="nifi@YOURREALM.COM"; - }; -- NOTE: The serviceName in the JAAS file must match the Kerberos Service Name in the processor. - -
- Alternatively, the JAAS - configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab - directly in the processor properties. This will dynamically create a JAAS configuration like above, and - will take precedence over the java.security.auth.login.config system property. -
-- If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but - the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would - be the following: -
- KafkaClient { - org.apache.kafka.common.security.plain.PlainLoginModule required - username="nifi" - password="nifi-password"; - }; -- -
- NOTE: It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit - the username and password unencrypted. -
-- NOTE: Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making - it visible to components in other NARs that may access the providers. There is currently a known issue - where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. -
-- This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this - option the broker must be configured with a listener of the form: -
- SASL_SSL://host.name:port -- -
- See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration - depending on the SASL mechanism (GSSAPI or PLAIN). -
-- See the SSL section for a description of how to configure the SSL Context Service based on the - ssl.client.auth property. -
- - - http://git-wip-us.apache.org/repos/asf/nifi/blob/00b11e82/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_11/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_11/additionalDetails.html b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_11/additionalDetails.html new file mode 100644 index 0000000..760066d --- /dev/null +++ b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.ConsumeKafka_0_11/additionalDetails.html @@ -0,0 +1,143 @@ + + + + + ++ This Processor polls Apache Kafka + for data using KafkaConsumer API available with Kafka 0.11.x. When a message is received + from Kafka, this Processor emits a FlowFile where the content of the FlowFile is the value + of the Kafka message. +
+ + ++ The Security Protocol property allows the user to specify the protocol for communicating + with the Kafka broker. The following sections describe each of the protocols in further detail. +
++ This option provides an unsecured connection to the broker, with no client authentication and no encryption. + In order to use this option the broker must be configured with a listener of the form: +
+ PLAINTEXT://host.name:port ++ +
+ This option provides an encrypted connection to the broker, with optional client authentication. In order + to use this option the broker must be configured with a listener of the form: +
+ SSL://host.name:port ++ In addition, the processor must have an SSL Context Service selected. + +
+ If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will + not be required to present a certificate. In this case, the SSL Context Service selected may specify only + a truststore containing the public key of the certificate authority used to sign the broker's key. +
++ If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. + In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to + a truststore as described above. +
++ This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: +
+ SASL_PLAINTEXT://host.name:port ++ In addition, the Kerberos Service Name must be specified in the processor. + +
+ If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The + JAAS configuration can be provided by specifying the java.security.auth.login.config system property in + NiFi's bootstrap.conf, such as: +
+ java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf ++ +
+ An example of the JAAS config file would be the following: +
+ KafkaClient { + com.sun.security.auth.module.Krb5LoginModule required + useKeyTab=true + storeKey=true + keyTab="/path/to/nifi.keytab" + serviceName="kafka" + principal="nifi@YOURREALM.COM"; + }; ++ NOTE: The serviceName in the JAAS file must match the Kerberos Service Name in the processor. + +
+ Alternatively, the JAAS + configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab + directly in the processor properties. This will dynamically create a JAAS configuration like above, and + will take precedence over the java.security.auth.login.config system property. +
++ If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but + the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would + be the following: +
+ KafkaClient { + org.apache.kafka.common.security.plain.PlainLoginModule required + username="nifi" + password="nifi-password"; + }; ++ +
+ NOTE: It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit + the username and password unencrypted. +
++ NOTE: Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making + it visible to components in other NARs that may access the providers. There is currently a known issue + where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. +
++ This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: +
+ SASL_SSL://host.name:port ++ +
+ See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration + depending on the SASL mechanism (GSSAPI or PLAIN). +
++ See the SSL section for a description of how to configure the SSL Context Service based on the + ssl.client.auth property. +
+ + + http://git-wip-us.apache.org/repos/asf/nifi/blob/00b11e82/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_10/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_10/additionalDetails.html b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_10/additionalDetails.html deleted file mode 100644 index 9d5882e..0000000 --- a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_10/additionalDetails.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - -- This Processor puts the contents of a FlowFile to a Topic in - Apache Kafka using KafkaProducer API available - with Kafka 0.11.x API. The contents of the incoming FlowFile will be read using the - configured Record Reader. Each record will then be serialized using the configured - Record Writer, and this serialized form will be the content of a Kafka message. - This message is optionally assigned a key by using the <Kafka Key> Property. -
- - -- The Security Protocol property allows the user to specify the protocol for communicating - with the Kafka broker. The following sections describe each of the protocols in further detail. -
-- This option provides an unsecured connection to the broker, with no client authentication and no encryption. - In order to use this option the broker must be configured with a listener of the form: -
- PLAINTEXT://host.name:port -- -
- This option provides an encrypted connection to the broker, with optional client authentication. In order - to use this option the broker must be configured with a listener of the form: -
- SSL://host.name:port -- In addition, the processor must have an SSL Context Service selected. - -
- If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will - not be required to present a certificate. In this case, the SSL Context Service selected may specify only - a truststore containing the public key of the certificate authority used to sign the broker's key. -
-- If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. - In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to - a truststore as described above. -
-- This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this - option the broker must be configured with a listener of the form: -
- SASL_PLAINTEXT://host.name:port -- In addition, the Kerberos Service Name must be specified in the processor. - -
- If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The - JAAS configuration can be provided by specifying the java.security.auth.login.config system property in - NiFi's bootstrap.conf, such as: -
- java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf -- -
- An example of the JAAS config file would be the following: -
- KafkaClient { - com.sun.security.auth.module.Krb5LoginModule required - useKeyTab=true - storeKey=true - keyTab="/path/to/nifi.keytab" - serviceName="kafka" - principal="nifi@YOURREALM.COM"; - }; -- NOTE: The serviceName in the JAAS file must match the Kerberos Service Name in the processor. - -
- Alternatively, the JAAS - configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab - directly in the processor properties. This will dynamically create a JAAS configuration like above, and - will take precedence over the java.security.auth.login.config system property. -
-- If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but - the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would - be the following: -
- KafkaClient { - org.apache.kafka.common.security.plain.PlainLoginModule required - username="nifi" - password="nifi-password"; - }; -- -
- NOTE: It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit - the username and password unencrypted. -
-- NOTE: Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making - it visible to components in other NARs that may access the providers. There is currently a known issue - where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. -
-- This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this - option the broker must be configured with a listener of the form: -
- SASL_SSL://host.name:port -- -
- See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration - depending on the SASL mechanism (GSSAPI or PLAIN). -
-- See the SSL section for a description of how to configure the SSL Context Service based on the - ssl.client.auth property. -
- - http://git-wip-us.apache.org/repos/asf/nifi/blob/00b11e82/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_11/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_11/additionalDetails.html b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_11/additionalDetails.html new file mode 100644 index 0000000..9d5882e --- /dev/null +++ b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafkaRecord_0_11/additionalDetails.html @@ -0,0 +1,144 @@ + + + + + ++ This Processor puts the contents of a FlowFile to a Topic in + Apache Kafka using KafkaProducer API available + with Kafka 0.11.x API. The contents of the incoming FlowFile will be read using the + configured Record Reader. Each record will then be serialized using the configured + Record Writer, and this serialized form will be the content of a Kafka message. + This message is optionally assigned a key by using the <Kafka Key> Property. +
+ + ++ The Security Protocol property allows the user to specify the protocol for communicating + with the Kafka broker. The following sections describe each of the protocols in further detail. +
++ This option provides an unsecured connection to the broker, with no client authentication and no encryption. + In order to use this option the broker must be configured with a listener of the form: +
+ PLAINTEXT://host.name:port ++ +
+ This option provides an encrypted connection to the broker, with optional client authentication. In order + to use this option the broker must be configured with a listener of the form: +
+ SSL://host.name:port ++ In addition, the processor must have an SSL Context Service selected. + +
+ If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will + not be required to present a certificate. In this case, the SSL Context Service selected may specify only + a truststore containing the public key of the certificate authority used to sign the broker's key. +
++ If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. + In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to + a truststore as described above. +
++ This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: +
+ SASL_PLAINTEXT://host.name:port ++ In addition, the Kerberos Service Name must be specified in the processor. + +
+ If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The + JAAS configuration can be provided by specifying the java.security.auth.login.config system property in + NiFi's bootstrap.conf, such as: +
+ java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf ++ +
+ An example of the JAAS config file would be the following: +
+ KafkaClient { + com.sun.security.auth.module.Krb5LoginModule required + useKeyTab=true + storeKey=true + keyTab="/path/to/nifi.keytab" + serviceName="kafka" + principal="nifi@YOURREALM.COM"; + }; ++ NOTE: The serviceName in the JAAS file must match the Kerberos Service Name in the processor. + +
+ Alternatively, the JAAS + configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab + directly in the processor properties. This will dynamically create a JAAS configuration like above, and + will take precedence over the java.security.auth.login.config system property. +
++ If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but + the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would + be the following: +
+ KafkaClient { + org.apache.kafka.common.security.plain.PlainLoginModule required + username="nifi" + password="nifi-password"; + }; ++ +
+ NOTE: It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit + the username and password unencrypted. +
++ NOTE: Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making + it visible to components in other NARs that may access the providers. There is currently a known issue + where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. +
++ This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: +
+ SASL_SSL://host.name:port ++ +
+ See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration + depending on the SASL mechanism (GSSAPI or PLAIN). +
++ See the SSL section for a description of how to configure the SSL Context Service based on the + ssl.client.auth property. +
+ + http://git-wip-us.apache.org/repos/asf/nifi/blob/00b11e82/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_10/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_10/additionalDetails.html b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_10/additionalDetails.html deleted file mode 100644 index 4d8de4e..0000000 --- a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_10/additionalDetails.html +++ /dev/null @@ -1,156 +0,0 @@ - - - - - -- This Processor puts the contents of a FlowFile to a Topic in - Apache Kafka using KafkaProducer API available - with Kafka 0.11.x API. The content of a FlowFile becomes the contents of a Kafka message. - This message is optionally assigned a key by using the <Kafka Key> Property. -
- -- The Processor allows the user to configure an optional Message Demarcator that - can be used to send many messages per FlowFile. For example, a \n could be used - to indicate that the contents of the FlowFile should be used to send one message - per line of text. It also supports multi-char demarcators (e.g., 'my custom demarcator'). - If the property is not set, the entire contents of the FlowFile - will be sent as a single message. When using the demarcator, if some messages are - successfully sent but other messages fail to send, the resulting FlowFile will be - considered a failed FlowFile and will have additional attributes to that effect. - One of such attributes is 'failed.last.idx' which indicates the index of the last message - that was successfully ACKed by Kafka. (if no demarcator is used the value of this index will be -1). - This will allow PublishKafka to only re-send un-ACKed messages on the next re-try. -
- - -- The Security Protocol property allows the user to specify the protocol for communicating - with the Kafka broker. The following sections describe each of the protocols in further detail. -
-- This option provides an unsecured connection to the broker, with no client authentication and no encryption. - In order to use this option the broker must be configured with a listener of the form: -
- PLAINTEXT://host.name:port -- -
- This option provides an encrypted connection to the broker, with optional client authentication. In order - to use this option the broker must be configured with a listener of the form: -
- SSL://host.name:port -- In addition, the processor must have an SSL Context Service selected. - -
- If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will - not be required to present a certificate. In this case, the SSL Context Service selected may specify only - a truststore containing the public key of the certificate authority used to sign the broker's key. -
-- If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. - In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to - a truststore as described above. -
-- This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this - option the broker must be configured with a listener of the form: -
- SASL_PLAINTEXT://host.name:port -- In addition, the Kerberos Service Name must be specified in the processor. - -
- If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The - JAAS configuration can be provided by specifying the java.security.auth.login.config system property in - NiFi's bootstrap.conf, such as: -
- java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf -- -
- An example of the JAAS config file would be the following: -
- KafkaClient { - com.sun.security.auth.module.Krb5LoginModule required - useKeyTab=true - storeKey=true - keyTab="/path/to/nifi.keytab" - serviceName="kafka" - principal="nifi@YOURREALM.COM"; - }; -- NOTE: The serviceName in the JAAS file must match the Kerberos Service Name in the processor. - -
- Alternatively, the JAAS - configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab - directly in the processor properties. This will dynamically create a JAAS configuration like above, and - will take precedence over the java.security.auth.login.config system property. -
-- If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but - the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would - be the following: -
- KafkaClient { - org.apache.kafka.common.security.plain.PlainLoginModule required - username="nifi" - password="nifi-password"; - }; -- -
- NOTE: It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit - the username and password unencrypted. -
-- NOTE: Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making - it visible to components in other NARs that may access the providers. There is currently a known issue - where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. -
-- This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this - option the broker must be configured with a listener of the form: -
- SASL_SSL://host.name:port -- -
- See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration - depending on the SASL mechanism (GSSAPI or PLAIN). -
-- See the SSL section for a description of how to configure the SSL Context Service based on the - ssl.client.auth property. -
- - http://git-wip-us.apache.org/repos/asf/nifi/blob/00b11e82/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_11/additionalDetails.html ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_11/additionalDetails.html b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_11/additionalDetails.html new file mode 100644 index 0000000..4d8de4e --- /dev/null +++ b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-0-11-processors/src/main/resources/docs/org.apache.nifi.processors.kafka.pubsub.PublishKafka_0_11/additionalDetails.html @@ -0,0 +1,156 @@ + + + + + ++ This Processor puts the contents of a FlowFile to a Topic in + Apache Kafka using KafkaProducer API available + with Kafka 0.11.x API. The content of a FlowFile becomes the contents of a Kafka message. + This message is optionally assigned a key by using the <Kafka Key> Property. +
+ ++ The Processor allows the user to configure an optional Message Demarcator that + can be used to send many messages per FlowFile. For example, a \n could be used + to indicate that the contents of the FlowFile should be used to send one message + per line of text. It also supports multi-char demarcators (e.g., 'my custom demarcator'). + If the property is not set, the entire contents of the FlowFile + will be sent as a single message. When using the demarcator, if some messages are + successfully sent but other messages fail to send, the resulting FlowFile will be + considered a failed FlowFile and will have additional attributes to that effect. + One of such attributes is 'failed.last.idx' which indicates the index of the last message + that was successfully ACKed by Kafka. (if no demarcator is used the value of this index will be -1). + This will allow PublishKafka to only re-send un-ACKed messages on the next re-try. +
+ + ++ The Security Protocol property allows the user to specify the protocol for communicating + with the Kafka broker. The following sections describe each of the protocols in further detail. +
++ This option provides an unsecured connection to the broker, with no client authentication and no encryption. + In order to use this option the broker must be configured with a listener of the form: +
+ PLAINTEXT://host.name:port ++ +
+ This option provides an encrypted connection to the broker, with optional client authentication. In order + to use this option the broker must be configured with a listener of the form: +
+ SSL://host.name:port ++ In addition, the processor must have an SSL Context Service selected. + +
+ If the broker specifies ssl.client.auth=none, or does not specify ssl.client.auth, then the client will + not be required to present a certificate. In this case, the SSL Context Service selected may specify only + a truststore containing the public key of the certificate authority used to sign the broker's key. +
++ If the broker specifies ssl.client.auth=required then the client will be required to present a certificate. + In this case, the SSL Context Service must also specify a keystore containing a client key, in addition to + a truststore as described above. +
++ This option uses SASL with a PLAINTEXT transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: +
+ SASL_PLAINTEXT://host.name:port ++ In addition, the Kerberos Service Name must be specified in the processor. + +
+ If the SASL mechanism is GSSAPI, then the client must provide a JAAS configuration to authenticate. The + JAAS configuration can be provided by specifying the java.security.auth.login.config system property in + NiFi's bootstrap.conf, such as: +
+ java.arg.16=-Djava.security.auth.login.config=/path/to/kafka_client_jaas.conf ++ +
+ An example of the JAAS config file would be the following: +
+ KafkaClient { + com.sun.security.auth.module.Krb5LoginModule required + useKeyTab=true + storeKey=true + keyTab="/path/to/nifi.keytab" + serviceName="kafka" + principal="nifi@YOURREALM.COM"; + }; ++ NOTE: The serviceName in the JAAS file must match the Kerberos Service Name in the processor. + +
+ Alternatively, the JAAS + configuration when using GSSAPI can be provided by specifying the Kerberos Principal and Kerberos Keytab + directly in the processor properties. This will dynamically create a JAAS configuration like above, and + will take precedence over the java.security.auth.login.config system property. +
++ If the SASL mechanism is PLAIN, then client must provide a JAAS configuration to authenticate, but + the JAAS configuration must use Kafka's PlainLoginModule. An example of the JAAS config file would + be the following: +
+ KafkaClient { + org.apache.kafka.common.security.plain.PlainLoginModule required + username="nifi" + password="nifi-password"; + }; ++ +
+ NOTE: It is not recommended to use a SASL mechanism of PLAIN with SASL_PLAINTEXT, as it would transmit + the username and password unencrypted. +
++ NOTE: Using the PlainLoginModule will cause it be registered in the JVM's static list of Providers, making + it visible to components in other NARs that may access the providers. There is currently a known issue + where Kafka processors using the PlainLoginModule will cause HDFS processors with Keberos to no longer work. +
++ This option uses SASL with an SSL/TLS transport layer to authenticate to the broker. In order to use this + option the broker must be configured with a listener of the form: +
+ SASL_SSL://host.name:port ++ +
+ See the SASL_PLAINTEXT section for a description of how to provide the proper JAAS configuration + depending on the SASL mechanism (GSSAPI or PLAIN). +
++ See the SSL section for a description of how to configure the SSL Context Service based on the + ssl.client.auth property. +
+ + http://git-wip-us.apache.org/repos/asf/nifi/blob/00b11e82/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-1-0-nar/pom.xml ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-1-0-nar/pom.xml b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-1-0-nar/pom.xml new file mode 100644 index 0000000..f1806a1 --- /dev/null +++ b/nifi-nar-bundles/nifi-kafka-bundle/nifi-kafka-1-0-nar/pom.xml @@ -0,0 +1,40 @@ +