[
https://issues.apache.org/jira/browse/NIFI-5469?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16560200#comment-16560200
]
ASF GitHub Bot commented on NIFI-5469:
--------------------------------------
Github user alopresto commented on a diff in the pull request:
https://github.com/apache/nifi/pull/2922#discussion_r205880893
--- Diff: nifi-docs/src/main/asciidoc/administration-guide.adoc ---
@@ -2434,82 +2538,82 @@ Before you begin, confirm that:
+
|====
|*Required Information*|*Description*
-|Source ZooKeeper hostname (*sourceHostname*)|The hostname must be one of
the hosts running in the ZooKeeper ensemble, which can be found in <NiFi
installation dir>/conf/zookeeper.properties. Any of the hostnames declared in
the *server.N* properties can be used.
-|Destination ZooKeeper hostname (*destinationHostname*)|The hostname must
be one of the hosts running in the ZooKeeper ensemble, which can be found in
<NiFi installation dir>/conf/zookeeper.properties. Any of the hostnames
declared in the *server.N* properties can be used.
-|Source ZooKeeper port (*sourceClientPort*)|This can be found in
*zookeeper.properties* of the <NiFi installation
dir>/conf/zookeeper.properties. The port is specified in the *clientPort*
property.
-|Destination ZooKeeper port (*destinationClientPort*)|This can be found in
*zookeeper.properties* of the <NiFi installation
dir>/conf/zookeeper.properties. The port is specified in the *clientPort*
property.
+|Source ZooKeeper hostname (*sourceHostname*)|The hostname must be one of
the hosts running in the ZooKeeper ensemble, which can be found in _<NiFi
installation dir>/conf/zookeeper.properties_. Any of the hostnames declared in
the *server.N* properties can be used.
+|Destination ZooKeeper hostname (*destinationHostname*)|The hostname must
be one of the hosts running in the ZooKeeper ensemble, which can be found in
_<NiFi installation dir>/conf/zookeeper.properties_. Any of the hostnames
declared in the *server.N* properties can be used.
+|Source ZooKeeper port (*sourceClientPort*)|This can be found in
*zookeeper.properties* of the _<NiFi installation
dir>/conf/zookeeper.properties_. The port is specified in the *clientPort*
property.
+|Destination ZooKeeper port (*destinationClientPort*)|This can be found in
*zookeeper.properties* of the _<NiFi installation
dir>/conf/zookeeper.properties_. The port is specified in the *clientPort*
property.
|Export data path|Determine the path that will store a json file
containing the export of data from ZooKeeper. It must be readable and writable
by the user running the zk-migrator tool.
-|Source ZooKeeper Authentication Information|This information is in <NiFi
installation dir>/conf/state-management.xml. For NiFi 0.x, if Creator Only is
specified in state-management.xml, you need to supply authentication
information using the `-a,--auth` argument with the values from the Username
and Password properties in state-management.xml. For NiFi 1.x, supply
authentication information using the `-k,--krb-conf` argument.
-+
-If the state-management.xml specifies Open, no authentication is required.
-|Destination ZooKeeper Authentication Information|This information is in
<NiFi installation dir>/conf/state-management.xml. For NiFi 0.x, if Creator
Only is specified in state-management.xml, you need to supply authentication
information using the `-a,--auth` argument with the values from the Username
and Password properties in state-management.xml. For NiFi 1.x, supply
authentication information using the `-k,--krb-conf` argument.
-+
-If the state-management.xml specifies Open, no authentication is required.
-|Root path to which NiFi writes data in Source ZooKeeper
(*sourceRootPath*)|This information can be found in <NiFi installation
dir>/conf/state-management.xml under the Root Node property in the
cluster-provider element. (default: /nifi)
-|Root path to which NiFi writes data in Destination ZooKeeper
(*destinationRootPath*)|This information can be found in <NiFi installation
dir>/conf/state-management.xml under the Root Node property in the
cluster-provider element.
+|Source ZooKeeper Authentication Information|This information is in _<NiFi
installation dir>/conf/state-management.xml_. For NiFi 0.x, if Creator Only is
specified in _state-management.xml_, you need to supply authentication
information using the `-a,--auth` argument with the values from the Username
and Password properties in _state-management.xml_. For NiFi 1.x, supply
authentication information using the `-k,--krb-conf` argument.
+
+If the _state-management.xml_ specifies Open, no authentication is
required.
+|Destination ZooKeeper Authentication Information|This information is in
_<NiFi installation dir>/conf/state-management.xml_. For NiFi 0.x, if Creator
Only is specified in _state-management.xml_, you need to supply authentication
information using the `-a,--auth` argument with the values from the Username
and Password properties in state-management.xml. For NiFi 1.x, supply
authentication information using the `-k,--krb-conf` argument.
+
+If the _state-management.xml_ specifies Open, no authentication is
required.
+|Root path to which NiFi writes data in Source ZooKeeper
(*sourceRootPath*)|This information can be found in `<NiFi installation
dir>/conf/state-management.xml` under the Root Node property in the
cluster-provider element. (default: `/nifi`)
+|Root path to which NiFi writes data in Destination ZooKeeper
(*destinationRootPath*)|This information can be found in _<NiFi installation
dir>/conf/state-management.xml_ under the Root Node property in the
cluster-provider element.
|====
2. Stop all processors in the NiFi flow. If you are migrating between two
NiFi installations, the flows on both must be stopped.
3. Export the NiFi component data from the source ZooKeeper. The
following command reads from the specified ZooKeeper running on the given
hostname:port, using the provided path to the data, and authenticates with
ZooKeeper using the given username and password. The data read from ZooKeeper
is written to the file provided.
* For NiFi 0.x
** For an open ZooKeeper:
-*** zk-migrator.sh -r -z
*sourceHostname:sourceClientPort*/*sourceRootPath*/components -f
/*path*/*to*/*export*/*zk-source-data.json*
+*** `zk-migrator.sh -r -z
*sourceHostname:sourceClientPort*/*sourceRootPath*/components -f
/*path*/*to*/*export*/*zk-source-data.json*`
** For a ZooKeeper using username:password for authentication:
-*** zk-migrator.sh -r -z
*sourceHostname:sourceClientPort*/*sourceRootPath*/components -a
<username:password> -f /*path*/*to*/*export*/*zk-source-data.json*
+*** `zk-migrator.sh -r -z
*sourceHostname:sourceClientPort*/*sourceRootPath*/components -a
<username:password> -f /*path*/*to*/*export*/*zk-source-data.json*`
* For NiFi 1.x
** For an open ZooKeeper:
-*** zk-migrator.sh -r -z
*sourceHostname:sourceClientPort*/*sourceRootPath*/components -f
/*path*/*to*/*export*/*zk-source-data.json*
+*** `zk-migrator.sh -r -z
*sourceHostname:sourceClientPort*/*sourceRootPath*/components -f
/*path*/*to*/*export*/*zk-source-data.json*`
** For a ZooKeeper using Kerberos for authentication:
-*** zk-migrator.sh -r -z
*sourceHostname:sourceClientPort*/*sourceRootPath*/components -k
/*path*/*to*/*jaasconfig*/*jaas-config.conf* -f
/*path*/*to*/*export*/*zk-source-data.json*
+*** `zk-migrator.sh -r -z
*sourceHostname:sourceClientPort*/*sourceRootPath*/components -k
/*path*/*to*/*jaasconfig*/*jaas-config.conf* -f
/*path*/*to*/*export*/*zk-source-data.json*`
4. (Optional) If you have used the new NiFi installation to do any
processing, you can also export its ZooKeeper data as a backup prior to
performing the migration.
* For an open ZooKeeper:
-** zk-migrator.sh -r -z
*destinationHostname:destinationClientPort*/*destinationRootPath*/components -f
/*path*/*to*/*export*/*zk-destination-backup-data.json*
+** `zk-migrator.sh -r -z
*destinationHostname:destinationClientPort*/*destinationRootPath*/components -f
/*path*/*to*/*export*/*zk-destination-backup-data.json*`
* For a ZooKeeper using Kerberos for authentication:
-** zk-migrator.sh -r -z
*destinationHostname:destinationClientPort*/*destinationRootPath*/components -k
/*path*/*to*/*jaasconfig*/*jaas-config.conf* -f
/*path*/*to*/*export*/*zk-destination-backup-data.json*
+** `zk-migrator.sh -r -z
*destinationHostname:destinationClientPort*/*destinationRootPath*/components -k
/*path*/*to*/*jaasconfig*/*jaas-config.conf* -f
/*path*/*to*/*export*/*zk-destination-backup-data.json*`
5. Migrate the ZooKeeper data to the destination ZooKeeper. If the source
and destination ZooKeepers are the same, the `--ignore-source` option can be
added to the following examples.
* For an open ZooKeeper:
-** zk-migrator.sh -s -z
*destinationHostname:destinationClientPort*/*destinationRootPath*/components -f
/*path*/*to*/*export*/*zk-source-data.json*
+** `zk-migrator.sh -s -z
*destinationHostname:destinationClientPort*/*destinationRootPath*/components -f
/*path*/*to*/*export*/*zk-source-data.json*`
* For a ZooKeeper using Kerberos for authentication:
-** zk-migrator.sh -s -z
*destinationHostname:destinationClientPort*/*destinationRootPath*/components -k
/*path*/*to*/*jaasconfig*/*jaas-config.conf* -f
/*path*/*to*/*export*/*zk-source-data.json*
+** `zk-migrator.sh -s -z
*destinationHostname:destinationClientPort*/*destinationRootPath*/components -k
/*path*/*to*/*jaasconfig*/*jaas-config.conf* -f
/*path*/*to*/*export*/*zk-source-data.json*`
6. Once the migration has completed successfully, start the processors in
the NiFi flow. Processing should continue from the point at which it was
stopped when the NiFi flow was stopped.
[[bootstrap_properties]]
== Bootstrap Properties
-The _bootstrap.conf_ file in the _conf_ directory allows users to
configure settings for how NiFi should be started.
+The _bootstrap.conf_ file in the `conf` directory allows users to
configure settings for how NiFi should be started.
This includes parameters, such as the size of the Java Heap, what Java
command to run, and Java System Properties.
Here, we will address the different properties that are made available in
the file. Any changes to this file will
take effect only after NiFi has been stopped and restarted.
|====
|*Property*|*Description*
-|java|Specifies the fully qualified java command to run. By default, it is
simply `java` but could be changed to an absolute path or a reference an
environment variable, such as `$JAVA_HOME/bin/java`
-|run.as|The username to run NiFi as. For instance, if NiFi should be run
as the 'nifi' user, setting this value to 'nifi' will cause the NiFi Process to
be run as the 'nifi' user.
+|`java`|Specifies the fully qualified java command to run. By default, it
is simply `java` but could be changed to an absolute path or a reference an
environment variable, such as `$JAVA_HOME/bin/java`
+|`run.as`|The username to run NiFi as. For instance, if NiFi should be run
as the `nifi` user, setting this value to `nifi` will cause the NiFi Process to
be run as the `nifi` user.
This property is ignored on Windows. For Linux, the specified user
may require sudo permissions.
-|lib.dir|The _lib_ directory to use for NiFi. By default, this is set to
`./lib`
-|conf.dir|The _conf_ directory to use for NiFi. By default, this is set to
`./conf`
-|graceful.shutdown.seconds|When NiFi is instructed to shutdown, the
Bootstrap will wait this number of seconds for the process to shutdown cleanly.
At this amount of time,
+|`lib.dir`|The _lib_ directory to use for NiFi. By default, this is set to
`./lib`
+|`conf.dir`|The _conf_ directory to use for NiFi. By default, this is set
to `./conf`
+|`graceful.shutdown.seconds`|When NiFi is instructed to shutdown, the
Bootstrap will wait this number of seconds for the process to shutdown cleanly.
At this amount of time,
if the service is still running, the Bootstrap
will "kill" the process, or terminate it abruptly.
--- End diff --
Put `kill` in code formatting as it is a shell builtin.
> Edits needed for LDAP and Kerberos login identity provider sections in Admin
> Guide
> ----------------------------------------------------------------------------------
>
> Key: NIFI-5469
> URL: https://issues.apache.org/jira/browse/NIFI-5469
> Project: Apache NiFi
> Issue Type: Improvement
> Components: Documentation & Website
> Reporter: Andrew Lim
> Assignee: Andrew Lim
> Priority: Minor
>
> Going through the Authentication and Authorization sections of the Admin
> Guide, I noticed the following improvements could be made:
> * Removed “Kerberos Config File” property from kerberos-provider login
> identity provider (this was done because the same property exists in
> nifi.properties)
> * Corrected the "LDAP-based Users/Groups Referencing User Attribute” login
> identity provider example to refer to “member uid"
> * Added titles to login identity provider examples for improved
> readability/search
> * Changed UserGroupProvider property examples from bulleted lists to tables
> Also, text formatting for references to config files, directories, etc. need
> to be made consistent. For example, config files like _nifi.properties_,
> _authorizers.xml_ should be italicized. Directories, properties and default
> values for properties should be monospaced.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
