NIFI-259: Adjusting property description of the connect string to be more specific concerning socket tuple format and the associated default port if one is not specified. Providing minor cleanup and removing unused import.
Project: http://git-wip-us.apache.org/repos/asf/nifi/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi/commit/69028126 Tree: http://git-wip-us.apache.org/repos/asf/nifi/tree/69028126 Diff: http://git-wip-us.apache.org/repos/asf/nifi/diff/69028126 Branch: refs/heads/master Commit: 690281267858a91d7b8893f329d3f2925a408701 Parents: 329e1fe Author: Aldrin Piri <ald...@apache.org> Authored: Thu Jan 28 18:22:13 2016 -0600 Committer: Aldrin Piri <ald...@apache.org> Committed: Mon Feb 1 10:38:45 2016 -0500 ---------------------------------------------------------------------- .../nifi/annotation/behavior/Stateful.java | 2 +- .../org/apache/nifi/util/NiFiProperties.java | 3 -- .../src/main/asciidoc/administration-guide.adoc | 18 +++++++----- .../src/main/asciidoc/developer-guide.adoc | 6 ++-- .../nifi-framework/nifi-framework-core/pom.xml | 31 +++++++++++--------- .../zookeeper/ZooKeeperStateProvider.java | 5 ++-- 6 files changed, 34 insertions(+), 31 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi/blob/69028126/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java ---------------------------------------------------------------------- diff --git a/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java b/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java index f352596..de32bd7 100644 --- a/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java +++ b/nifi-api/src/main/java/org/apache/nifi/annotation/behavior/Stateful.java @@ -50,5 +50,5 @@ public @interface Stateful { /** * Indicates the Scope(s) associated with the State that is stored and retrieved. */ - Scope[]scopes(); + Scope[] scopes(); } http://git-wip-us.apache.org/repos/asf/nifi/blob/69028126/nifi-commons/nifi-properties/src/main/java/org/apache/nifi/util/NiFiProperties.java ---------------------------------------------------------------------- diff --git a/nifi-commons/nifi-properties/src/main/java/org/apache/nifi/util/NiFiProperties.java b/nifi-commons/nifi-properties/src/main/java/org/apache/nifi/util/NiFiProperties.java index 5b35328..c432edf 100644 --- a/nifi-commons/nifi-properties/src/main/java/org/apache/nifi/util/NiFiProperties.java +++ b/nifi-commons/nifi-properties/src/main/java/org/apache/nifi/util/NiFiProperties.java @@ -1000,9 +1000,6 @@ public class NiFiProperties extends Properties { return new File(getProperty(STATE_MANAGEMENT_CONFIG_FILE, DEFAULT_STATE_MANAGEMENT_CONFIG_FILE)); } - /* - * public static final String STATE_MANAGEMENT_MAX_ZOOKEEPER_SERVERS = "nifi.state.management.embedded.zookeeper.max.instances"; - */ public String getLocalStateProviderId() { return getProperty(STATE_MANAGEMENT_LOCAL_PROVIDER_ID); } http://git-wip-us.apache.org/repos/asf/nifi/blob/69028126/nifi-docs/src/main/asciidoc/administration-guide.adoc ---------------------------------------------------------------------- diff --git a/nifi-docs/src/main/asciidoc/administration-guide.adoc b/nifi-docs/src/main/asciidoc/administration-guide.adoc index dd7f3eb..3310f0b 100644 --- a/nifi-docs/src/main/asciidoc/administration-guide.adoc +++ b/nifi-docs/src/main/asciidoc/administration-guide.adoc @@ -400,18 +400,20 @@ may be referenced by their identifiers. By default, the Local State Provider is persists the data to the _$NIFI_HOME/state_ directory. The default Cluster State Provider is configured to be a `ZooKeeperStateProvider`. The default ZooKeeper-based provider must have its `Connect String` property populated before it can be used. It is also advisable, if multiple NiFi instances will use the same ZooKeeper instance, that the value of the `Root Node` property be changed. For instance, -one might set the value to `/nifi/<team name>/production`. +one might set the value to `/nifi/<team name>/production`. A `Connect String` takes the form of comma separated <host>:<port> tuples, +such as my-zk-server1:2181,my-zk-server2:2181,my-zk-server3:2181. In the event a port is not specified for any of the hosts, the ZooKeeper +default of 2181 is assumed. When adding data to ZooKeeper, there are two options for Access Control: `Open` and `CreatorOnly`. If the `Access Control` property is set to `Open`, then anyone is allowed to log into ZooKeeper and have full permissions to see, change, delete, or administer the data. -If `CreatorOnly` is specified, then only user that is allowed to read, change, delete, or administer the data is the user that was used -to create the data. In order to use the `CreatorOnly` option, NiFi must provide some form of authentication. See the <<zk_access_control>> +If `CreatorOnly` is specified, then only the user that created the data is allowed to read, change, delete, or administer the data. +In order to use the `CreatorOnly` option, NiFi must provide some form of authentication. See the <<zk_access_control>> section below for more information on how to configure authentication. If NiFi is configured to run in a standalone mode, the `cluster-state-provider` element need not be populated in the _state-management.xml_ file and will actually be ignored if they are populated. However, the `local-state-provider` element must always be present and populated. Additionally, if NiFi is run in a cluster, each node must also have the `cluster-state-provider` element present and properly configured. -Otherwise, NiFi will fail to startup. +Otherwise, NiFi will fail to startup. While there are not many properties that need to be configured for these providers, they were externalized into a separate _state-providers.xml_ file, rather than being configured via the _nifi.properties_ file, simply because different implementations may require different properties, @@ -427,7 +429,7 @@ instead of the Local State Provider. [[embedded_zookeeper]] === Embedded ZooKeeper Server As mentioned above, the default State Provider for cluster-wide state is the `ZooKeeperStateProvider`. At the time of this writing, this is the -only State Provider that exists for handling cluster-wide state. What this means is that NiFi has a dependencies on ZooKeeper in order to +only State Provider that exists for handling cluster-wide state. What this means is that NiFi has dependencies on ZooKeeper in order to behave as a cluster. However, there are many environments in which NiFi is deployed where there is no existing ZooKeeper ensemble being maintained. In order to avoid the burden of forcing administrators to also maintain a separate ZooKeeper instance, NiFi provides the option of starting an embedded ZooKeeper server. @@ -439,7 +441,7 @@ running ZooKeeper on 4 nodes provides no more benefit than running on 3 nodes, Z However, it is up to the administrator to determine the number of nodes most appropriate to the particular deployment of NiFi. If the `nifi.state.management.embedded.zookeeper.start` property is set to `true`, the `nifi.state.management.embedded.zookeeper.properties` property -in _nifi.properties_ also becomes relevant. This specifies the ZooKeeper properties file to use. At a minimum, This properties file needs to be populated +in _nifi.properties_ also becomes relevant. This specifies the ZooKeeper properties file to use. At a minimum, this properties file needs to be populated with the list of ZooKeeper servers. Each of these servers is configured as <hostname>:<client port>[:<leader election port>]. For example, `myhost:2888:3888`. This list of nodes should be the same nodes in the NiFi cluster that have the `nifi.state.management.embedded.zookeeper.start` property set to `true`. Also note that because ZooKeeper will be listening on these ports, the firewall may need to be configured to open these ports @@ -486,7 +488,7 @@ The second option is to use a user name and password. This is configured by spec for the `ZooKeeperStateProvider` (see the <<state_providers>> section for more information). The important thing to keep in mind here, though, is that ZooKeeper will pass around the password in plain text. This means that using a user name and password should not be used unless ZooKeeper is running on localhost as a one-instance cluster, or if communications with ZooKeeper occur only over encrypted communications, such as a VPN or an SSL connection. ZooKeeper will be -providing support for SSL connections in version 0.5.0. +providing support for SSL connections in version 3.5.0. @@ -495,7 +497,7 @@ providing support for SSL connections in version 0.5.0. When NiFi communicates with ZooKeeper, all communications, by default, are non-secure, and anyone who logs into ZooKeeper is able to view and manipulate all of the NiFi state that is stored in ZooKeeper. To prevent this, we can use Kerberos to manage the authentication. At this time, ZooKeeper does not provide -support for encryption via SSL. Support for SSL in ZooKeeper is being actively worked and is expected to be available in the 0.5.x version of ZooKeeper. +support for encryption via SSL. Support for SSL in ZooKeeper is being actively developed and is expected to be available in the 3.5.x release version. In order to secure the communications, we need to ensure that both the client and the server support the same configuration. Instructions for configuring the NiFi ZooKeeper client and embedded ZooKeeper server to use Kerberos are provided below. http://git-wip-us.apache.org/repos/asf/nifi/blob/69028126/nifi-docs/src/main/asciidoc/developer-guide.adoc ---------------------------------------------------------------------- diff --git a/nifi-docs/src/main/asciidoc/developer-guide.adoc b/nifi-docs/src/main/asciidoc/developer-guide.adoc index f9bf675..75f9ecf 100644 --- a/nifi-docs/src/main/asciidoc/developer-guide.adoc +++ b/nifi-docs/src/main/asciidoc/developer-guide.adoc @@ -596,10 +596,10 @@ that the instance is clustered and write the code accordingly. State is stored using the StateManager's `set`, `replace`, `putIfAbsent`, `remove`, and `clear` methods. All of these methods, with the exception of `clear` take as the first argument the key to be set. The key that is used is unique only to the same instance of the component and for the same Scope. That is, if two Processors store a value using the key _My Key_, those Processors -will not conflict with each other, even if both Processors are of the same type (e.g., both are of type ListFile). Furthermore, +will not conflict with each other, even if both Processors are of the same type (e.g., both are of type ListFile) and scope. Furthermore, if a Processor stores a value with the key of _My Key_ using the `Scope.CLUSTER` scope, and then attempts to retrieve the value using the `Scope.NODE` scope, the value retrieved will be `null`. Each Processor's state, then, is stored in isolation from other -Processor's state. A unique key can be thought of as a triple of <Processor Instance, Key, Scope>. +Processors' state. A unique key can be thought of as a triple of <Processor Instance, Key, Scope>. It follows, then, that two Processors cannot share the same state. There are, however, some circumstances in which it is very necessary to share state between two Processors of different types, or two Processors of the same type. This can be accomplished @@ -793,7 +793,7 @@ public final class InvokeHTTP extends AbstractProcessor { ---- === Documenting Related Components -Often Processors and ControllerServices are related to one another. Sometimes its a put/get relation as in `PutFile` and `GetFile`. +Often Processors and ControllerServices are related to one another. Sometimes it is a put/get relation as in `PutFile` and `GetFile`. Sometimes a Processor uses a ControllerService like `InvokeHTTP` and `StandardSSLContextService`. Sometimes one ControllerService uses another like `DistributedMapCacheClientService` and `DistributedMapCacheServer`. Developers of these extension points may relate these different components using the `SeeAlso` tag. This annotation links these components in the documentation. http://git-wip-us.apache.org/repos/asf/nifi/blob/69028126/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml index f07d022..b6e8e82 100644 --- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml +++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/pom.xml @@ -1,16 +1,19 @@ <?xml version="1.0" encoding="UTF-8"?> -<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor - license agreements. See the NOTICE file distributed with this work for additional - information regarding copyright ownership. The ASF licenses this file to - You under the Apache License, Version 2.0 (the "License"); you may not use - this file except in compliance with the License. You may obtain a copy of - the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required - by applicable law or agreed to in writing, software distributed under the - License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS - OF ANY KIND, either express or implied. See the License for the specific - language governing permissions and limitations under the License. --> -<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + http://www.apache.org/licenses/LICENSE-2.0 + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> <modelVersion>4.0.0</modelVersion> <parent> <groupId>org.apache.nifi</groupId> @@ -120,12 +123,12 @@ <groupId>org.apache.zookeeper</groupId> <artifactId>zookeeper</artifactId> </dependency> - + <dependency> <groupId>org.apache.nifi</groupId> <artifactId>nifi-processor-utils</artifactId> </dependency> - + <dependency> <groupId>org.apache.curator</groupId> <artifactId>curator-test</artifactId> http://git-wip-us.apache.org/repos/asf/nifi/blob/69028126/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/state/providers/zookeeper/ZooKeeperStateProvider.java ---------------------------------------------------------------------- diff --git a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/state/providers/zookeeper/ZooKeeperStateProvider.java b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/state/providers/zookeeper/ZooKeeperStateProvider.java index cb310a0..b1764eb 100644 --- a/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/state/providers/zookeeper/ZooKeeperStateProvider.java +++ b/nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-framework-core/src/main/java/org/apache/nifi/controller/state/providers/zookeeper/ZooKeeperStateProvider.java @@ -60,7 +60,8 @@ public class ZooKeeperStateProvider extends AbstractStateProvider { static final PropertyDescriptor CONNECTION_STRING = new PropertyDescriptor.Builder() .name("Connect String") - .description("The ZooKeeper Connect String to use. This is a comma-separated list of hostnames/IP addresses, such as \"host1, host2, 127.0.0.1, host4, host5\"") + .description("The ZooKeeper Connect String to use. This is a comma-separated list of hostname/IP and port tuples, such as \"host1:2181,host2:2181,127.0.0.1:2181\". If a port is not " + + "specified it defaults to the ZooKeeper client port default of 2181") .addValidator(StandardValidators.NON_EMPTY_VALIDATOR) .required(false) .build(); @@ -216,7 +217,7 @@ public class ZooKeeperStateProvider extends AbstractStateProvider { private void verifyEnabled() throws IOException { if (!isEnabled()) { - throw new IOException("Cannot update or retrieve cluster state becuase node is no longer connected to a cluster"); + throw new IOException("Cannot update or retrieve cluster state because node is no longer connected to a cluster"); } }
