Incorrect Information

[cmusa17]

In this section of the document: Update Kafka configuration to use SSL and restart the brokers Step 6 says: Add configuration properties to the Kafka server.properties file to advertise IP addresses instead of the Fully Qualified Domain Name (FQDN). This is incorrect, the configuration properties should be added to the kafka-env template under the Kafka Configuration in Ambari and it should update the server.properties file in the back end. It would be best if we had a before and after screenshot showing the kafka-env template in Ambari with the settings added.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: c117dccb-22e3-b6b3-ae19-9e2b6ec477a8
• Version Independent ID: 4c0a71c1-e367-e103-2839-beb08348b2d6
• Content: Set up SSL encryption and authentication for Apache Kafka in Azure HDInsight
• Content Source: articles/hdinsight/kafka/apache-kafka-ssl-encryption-authentication.md
• Service: hdinsight
• GitHub Login: @hrasheed-msft
• Microsoft Alias: hrasheed

[CHEEKATLAPRADEEP-MSFT-zz]

@cmusa17 Thanks for the feedback! I have assigned the issue to the content author to review further and update the document as appropriate.

[hrasheed-msft]

@cmusa17 Hello, thanks for reaching out. When you say "incorrect" do you mean that the steps provided will not work and users must go through Ambari to update the server.properties file? Or do you mean than going through Ambari is the preferred method.

Did you encounter a specific error when executing the steps as described?

I believe that the steps were provided through the command line (rather than the Ambari UI) to help users get the IP addresses and insert into the properties file with as few steps as possible.

[cmusa17]

@hrasheed-msft these settings should be added by going to Ambari and editing the kafka-env template under the Kafka Configuration.

The statement is misleading in that the user may think he/she needs to add these settings directly to the server.properties file in his/her cluster.

Once these settings are added to the kafka-env template under the Kafka Configuration, after restarting the Kafka brokers, then these settings will be added to the server.properties file on the Kafka server. A user can check that file to verify that the settings were added correctly in Ambari.

I had a customer who had an issue with this that is why I am suggesting adding a screenshot showing the settings after they have been added in the kafka-env template under the Kafka Configuration.

[hrasheed-msft]

@cmusa17 It sounds like you're saying they were confused and though that in step 6 they needed to edit the file manually. I have adjusted the language to clarify that the following commands will make those edits.

There are multiple ways to edit the server.properties file, correct? Ambari is one way, but I think it can also be edited manually or through a script. I believe it is accurate to say that the commands in step 6 do edit the server.properties file directly.

Are you saying that those commands don't produce the intended result and users will still need to go through Ambari to edit the server.properties file?

Or do you feel that having them go through Ambari is an overall best practice that is less prone to user error so we should recommend that route?

The developer that provided these steps also validated them through work on actual clusters with users, so I want to make sure that I understand your suggestion completely. Thanks.

[hrasheed-msft]

@CHEEKATLAPRADEEP-MSFT the issue has been fixed in the referenced pull request.

[hrasheed-msft]

please-close