Github user alopresto commented on a diff in the pull request:
https://github.com/apache/nifi/pull/491#discussion_r65754466
--- Diff: nifi-docs/src/main/asciidoc/administration-guide.adoc ---
@@ -1351,66 +1389,81 @@ in the file specified in
`nifi.login.identity.provider.configuration.file`. Sett
|nifi.security.ocsp.responder.certificate|This is the location of the OCSP
responder certificate if one is being used. It is blank by default.
|====
-*Cluster Common Properties* +
+==== Cluster Common Properties
-When setting up a NiFi cluster, these properties should be configured the
same way on both the cluster manager and the nodes.
+When setting up a NiFi cluster, these properties should be configured the
same way on all nodes.
|====
|*Property*|*Description*
-|nifi.cluster.protocol.heartbeat.interval|The interval at which nodes
should emit heartbeats to the cluster manager. The default value is 5 sec.
+|nifi.cluster.protocol.heartbeat.interval|The interval at which nodes
should emit heartbeats to the Cluster Coordinator. The default value is 5 sec.
|nifi.cluster.protocol.is.secure|This indicates whether cluster
communications are secure. The default value is _false_.
-|nifi.cluster.protocol.socket.timeout|The amount of time to wait for a
cluster protocol socket to be established before trying again. The default
value is 30 sec.
-|nifi.cluster.protocol.connection.handshake.timeout|The amount of time to
wait for a node to connect to the cluster. The default value is 45 sec.
+|nifi.cluster.node.event.history.size|When the state of a node in the
cluster is changed, an event is generated
+and can be viewed in the Cluster page. This value indicates how many
events to keep in memory for each node.
+|nifi.cluster.node.connection.timeout|When connecting to another node in
the cluster, specifies how long this node should wait before considering
+the connection a failure.
+|nifi.cluster.node.read.timeout|When communicating with another node in
the cluster, specifies how long this node should wait to receive information
+from the remote node before considering the communication with the node a
failure.
+|nifi.cluster.firewall.file|The location of the node firewall file. This
is a file that may be used to list all the nodes that are allowed to connect
+to the cluster. It provides an additional layer of security. This value is
blank by default, meaning that no firewall file is to be used.
|====
-*Multicast Cluster Common Properties* +
-If multicast is used, the following nifi.cluster.protocol.multicast.xxx
properties must be configured. By default, unicast is used.
+==== Cluster Node Properties
+
+Configure these properties for cluster nodes.
|====
|*Property*|*Description*
-|nifi.cluster.protocol.use.multicast|Indicates whether multicast is being
used. The default value is _false_.
-|nifi.cluster.protocol.multicast.address|The cluster multicast address. It
is blank by default.
-|nifi.cluster.protocol.multicast.port|The cluster multicast port. It is
blank by default.
-|nifi.cluster.protocol.multicast.service.broadcast.delay|The multicast
service broadcast delay. The default value is 500 ms.
-|nifi.cluster.protocol.multicast.service.locator.attempts|The number of
multicast service locator attempts to make. The default value is 3.
-|nifi.cluster.protocol.multicast.service.locator.attempts.delay|The
multicast service locator attempts delay. The default value is 1 sec.
+|nifi.cluster.is.node|Set this to _true_ if the instance is a node in a
cluster. The default value is _false_.
+|nifi.cluster.node.address|The fully qualified address of the node. It is
blank by default.
+|nifi.cluster.node.protocol.port|The node's protocol port. It is blank by
default.
+|nifi.cluster.node.protocol.threads|The number of threads that should be
used to communicate with other nodes
+in the cluster. This property defaults to 10, but for large clusters, this
value may need to be larger.
|====
-*Cluster Node Properties* +
-
-Only configure these properties for cluster nodes.
+[[claim_management]]
+==== Claim Management
+
+Whenever a request is made to change the dataflow, it is important that
+all nodes in the NiFi cluster are kept in-sync. In order to allow for
this, NiFi employs a two-phase commit. The request
+is first replicated to all nodes in the cluster, simply asking whether or
not the request is allowed. Each node then determines
+whether or not it will allow the request and if so issues a "Claim" on the
component(s) being modified. This claim can be
+thought of as a mutually-exclusive lock that is owned by the requestor.
Once all nodes have voted on whether or not the request
+is allowed, the node from which the request originated must decide whether
or not to complete the request. If any node voted
+'NO' then the request is canceled and the Claim is canceled with an error
message sent back to the user. However, if the nodes
+all vote 'YES' then the request is completed. In this sort of distributed
environment, it is possible that the node that
+made the original request will fail after the voting has occurred and
before the request was completed. This would leave
+the component locked indefinitely so that no more changes can be made to
the component. In order to avoid this, the Claim
+will time out after some period of time. These properties determines how
these locks are managed.
|====
|*Property*|*Description*
-|nifi.cluster.is.node|Set this to _true_ if the instance is a node in a
cluster. The default value is _false_.
-|nifi.cluster.node.address|The fully qualified address of the node. It is
blank by default.
-|nifi.cluster.node.protocol.port|The node's protocol port. It is blank by
default.
-|nifi.cluster.node.protocol.threads|The number of threads used for the
node protocol. The default value is 2.
-|nifi.cluster.node.unicast.manager.address|If multicast is not used, the
value for this property should be the same as the value configured on the
cluster manager for manager address.
-|nifi.cluster.node.unicast.manager.protocol.port|If multicast is not used,
the value for this property should be the same as the value configured on the
cluster manager for manager protocol port.
+|nifi.cluster.request.replication.claim.timeout|Specifies how long to wait
before considering a lock 'expired' and automatically
+unlocking.
|====
-*Cluster Manager Properties* +
-Only configure these properties for the cluster manager.
+==== ZooKeeper Properties
+
+NiFi depends on Apache ZooKeeper for determining which node in the cluster
should play the role of Primary Node
+and which node should play the role of Cluster Coordinator. These
properties must be configured in order for NiFi
+to join a cluster.
|====
|*Property*|*Description*
-|nifi.cluster.is.manager|Set this to _true_ if the instance is a cluster
manager. The default value is _false_.
-|nifi.cluster.manager.address|The fully qualified address of the cluster
manager. It is blank by default.
-|nifi.cluster.manager.protocol.port|The cluster manager's protocol port.
It is blank by default.
-|nifi.cluster.manager.node.firewall.file|The location of the node firewall
file. This is a file that may be used to list all the nodes that are allowed to
connect to the cluster. It provides an additional layer of security. This value
is blank by default.
-|nifi.cluster.manager.node.event.history.size|The size of the cluster
manager's event history. The default value is 10.
-|nifi.cluster.manager.node.api.connection.timeout|The amount of time to
wait for an API connection to be made. The default value is 30 sec.
-|nifi.cluster.manager.node.api.read.timeout|The API read timeout. The
default value is 30 sec.
-|nifi.cluster.manager.node.api.request.threads|The number of threads to
use for API requests. The default value is 10.
-|nifi.cluster.manager.flow.retrieval.delay|The delay before the cluster
manager retrieves the latest flow configuration. The default value is 5 sec.
-|nifi.cluster.manager.protocol.threads|The number of threads used for the
cluster manager protocol. The default value is 10.
-|nifi.cluster.manager.safemode.duration|Upon restart of an already
existing cluster, this is the amount of time that the cluster manager waits for
the primary node to connect before giving up and selecting another node to be
the primary node. The default value is 0 sec, which means to wait forever. If
the administrator does not care which node is the primary node, this value can
be changed to some amount of time other than 0 sec.
+|nifi.zookeeper.connect.string|The Connect String that is needed to
connect to Apache ZooKeeper. This is a comma-separted list
--- End diff --
Typo in "separated".
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at [email protected] or file a JIRA ticket
with INFRA.
---
