Skip to content

STORM-4079: Add SSL setup documentation#8428

Merged
rzo1 merged 5 commits intoapache:masterfrom
MNkulkarni06:STORM-4079-ssl-doc
Mar 19, 2026
Merged

STORM-4079: Add SSL setup documentation#8428
rzo1 merged 5 commits intoapache:masterfrom
MNkulkarni06:STORM-4079-ssl-doc

Conversation

@MNkulkarni06
Copy link
Contributor

@MNkulkarni06 MNkulkarni06 commented Mar 16, 2026

What is the purpose of the change

This PR adds documentation explaining how to configure SSL in Apache Storm.

It provides clear guidance for users who want to secure their Storm cluster communication.
The documentation explains the process of enabling SSL and configuring the required
security components.

The documentation includes:

  • Steps to generate keystore and truststore
  • Configuration required in storm.yaml
  • Instructions for enabling HTTPS for Storm UI

How was the change tested

The documentation was reviewed to ensure the configuration steps and commands are accurate
and consistent with the current Apache Storm configuration options. Since this change only
adds documentation and does not modify runtime code, no additional functional tests were required.

Copy link
Contributor

@rzo1 rzo1 left a comment

Choose a reason for hiding this comment

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

All of the mentioned properties do not exist. Please verify any changes (generated by generative AI).

Copy link
Contributor

@rzo1 rzo1 left a comment

Choose a reason for hiding this comment

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

Thanks for updating. Overall, I am wondering what the actual goal of this change is? I think the documenation as noted in the related issue lacks information on how to configure STorm to communicate over SSL/TLS (or mTLS) as implemented in https://issues.apache.org/jira/browse/STORM-4075.

That means we would need to update the docs to mention the config properties as described in the related PR: https://github.com/apache/storm/pull/3692/changes

The actual changes for normal SSL/LTS are already included: https://github.com/apache/storm/pull/8072/changes

For UI users needs to set following config in storm.yaml. Generating keystores with proper keys and certs should be taken care by the user before this step.

1. ui.https.port
1. ui.https.port (Port for HTTPS UI access)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this change can be removed since it is obvious.

</dependencySet>
</dependencySets>

<files>
Copy link
Contributor

Choose a reason for hiding this comment

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

These changes do nto belong to STORM-4079 and should be removed.

@MNkulkarni06
Copy link
Contributor Author

Thanks for the clarification.

I have added an overview explaining how TLS configuration works for internal communication using the existing configuration properties.

Please let me know if any further improvements are needed.

@rzo1 rzo1 requested a review from reiabreu March 18, 2026 07:45
@rzo1 rzo1 merged commit 7a2bcb7 into apache:master Mar 19, 2026
12 checks passed
@rzo1
Copy link
Contributor

rzo1 commented Mar 19, 2026

Thx

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants