Skip to content

NIFI-5653 Added default NiFi and Embedded Zookeeper port tables to Ad… #3089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
andrewmlim wants to merge 2 commits into from
Closed

NIFI-5653 Added default NiFi and Embedded Zookeeper port tables to Ad… #3089

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5628192
NIFI-5653 Added default NiFi and Embedded Zookeeper port tables to Ad…
andrewmlim Oct 17, 2018
3ee8c62
Update administration-guide.adoc
andrewmlim Oct 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 31 additions & 2 deletions nifi-docs/src/main/asciidoc/administration-guide.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,38 @@ When NiFi first starts up, the following files and directories are created:

See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.

== Port Configuration

=== NiFi
The following table lists the default ports used by NiFi and the corresponding property in the _nifi.properties_ file.

[options="header,footer"]
|==================================================================================================================================================
| Function | Property | Default Value
|HTTP Port | `nifi.web.http.port` | `8080`
|HTTPS Port* | `nifi.web.https.port` | `9443`
|Remote Input Socket Port* | `nifi.remote.input.socket.port` | `10443`
|Cluster Node Protocol Port* | `nifi.cluster.node.protocol.port` | `11443`
|Cluster Node Load Balancing Port | `nifi.cluster.node.load.balance.port` | `6342`
|Web HTTP Forwarding Port | `nifi.web.http.port.forwarding` | _none_
|==================================================================================================================================================

NOTE: The ports marked with an asterisk (*) have property values that are blank by default in _nifi.properties_. The values shown in the table are the default values for these ports when <<tls_generation_toolkit>> is used to generate _nifi.properties_ for a secured NiFi instance. The default Certificate Authority Port used by TLS Toolkit is `8443`.
Copy link
Contributor

@jtstorck jtstorck Oct 17, 2018

Choose a reason for hiding this comment

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

Suggested change
NOTE: The ports marked with an asterisk (*) have property values that are blank by default in _nifi.properties_. The values shown in the table are the default values for these ports when <<tls_generation_toolkit>> is used to generate _nifi.properties_ for a secured NiFi instance. The default Certificate Authority Port used by TLS Toolkit is `8443`.
NOTE: The ports marked with an asterisk (*) have property values that are empty by default in _nifi.properties_. The values shown in the table are the default values for these ports when <<tls_generation_toolkit>> is used to generate _nifi.properties_ for a secured NiFi instance. The default Certificate Authority Port used by TLS Toolkit is `8443`.

Copy link
Contributor Author

@andrewmlim andrewmlim Oct 17, 2018

Choose a reason for hiding this comment

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

Similar to comment above about "blank", but happy to make this change since it reads better.

Copy link
Contributor

@jtstorck jtstorck Oct 17, 2018

Choose a reason for hiding this comment

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

empty is probably not correct here. It could imply an empty string, which would not be the case for a property set like nifi.web.http.port.forwarding= as it is by default in nifi.properties. blank is probably the better option to use in the descriptions, but maybe null or none in the port lists?

Copy link
Contributor Author

@andrewmlim andrewmlim Oct 17, 2018

Choose a reason for hiding this comment

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

Yup, will make none in the tables.


=== Embedded Zookeeper
The following table lists the default ports used by an <<embedded_zookeeper>> and the corresponding property in the _zookeeper.properties_ file.

[options="header,footer"]
|==================================================================================================================================================
| Function | Property | Default Value
|Zookeeper Client Port | `clientPort` | `2181`
|Zookeeper Server Quorum and Leader Election Ports | `server.1` | _none_
|==================================================================================================================================================

NOTE: Commented examples for the Zookeeper server ports are included in the _zookeeper.properties_ file in the form `server.N=nifi-nodeN-hostname:2888:3888`.

== Configuration Best Practices
NOTE: If you are running on Linux, consider these best practices. Typical Linux defaults are not necessarily well-tuned for the needs of an IO intensive application like NiFi. For all of these areas, your distribution's requirements may vary. Use these sections as advice, but
If you are running on Linux, consider these best practices. Typical Linux defaults are not necessarily well-tuned for the needs of an IO intensive application like NiFi. For all of these areas, your distribution's requirements may vary. Use these sections as advice, but
consult your distribution-specific documentation for how best to achieve these recommendations.

Maximum File Handles::
Expand Down Expand Up @@ -159,7 +188,7 @@ the web server will REQUIRE certificate based client authentication. See <<user_
Now that the User Interface has been secured, we can easily secure Site-to-Site connections and inner-cluster communications, as well. This is
accomplished by setting the `nifi.remote.input.secure` and `nifi.cluster.protocol.is.secure` properties, respectively, to `true`.


[[tls_generation_toolkit]]
=== TLS Generation Toolkit

In order to facilitate the secure setup of NiFi, you can use the `tls-toolkit` command line utility to automatically generate the required keystores, truststore, and relevant configuration files. This is especially useful for securing multiple NiFi nodes, which can be a tedious and error-prone process.
Expand Down