[
https://issues.apache.org/jira/browse/NIFI-5469?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16560205#comment-16560205
]
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_r205881892
--- Diff: nifi-docs/src/main/asciidoc/administration-guide.adoc ---
@@ -2764,39 +2868,39 @@ The first section of the _nifi.properties_ file is
for the Core Properties. Thes
|===
|*Property*|*Description*
-|nifi.flow.configuration.file*|The location of the flow configuration file
(i.e., the file that contains what is currently displayed on the NiFi graph).
The default value is `./conf/flow.xml.gz`.
-|nifi.flow.configuration.archive.enabled*|Specifies whether NiFi creates a
backup copy of the flow automatically when the flow is updated. The default
value is `true`.
-|nifi.flow.configuration.archive.dir*|The location of the archive
directory where backup copies of the flow.xml are saved. The default value is
`./conf/archive`. NiFi removes old archive files to limit disk usage based on
archived file lifespan, total size, and number of files, as specified with
`nifi.flow.configuration.archive.max.time`, `max.storage` and `max.count`
properties respectively. If none of these limitation for archiving is
specified, NiFi uses default conditions, that is `30 days` for max.time and
`500 MB` for max.storage. +
-This cleanup mechanism takes into account only automatically created
archived flow.xml files. If there are other files or directories in this
archive directory, NiFi will ignore them. Automatically created archives have
filename with ISO 8601 format timestamp prefix followed by
'_<original-filename>'. That is
<year><month><day>T<hour><minute><second>+<timezone offset>_<original
filename>. For example, `20160706T160719+0900_flow.xml.gz`. NiFi checks
filenames when it cleans archive directory. If you would like to keep a
particular archive in this directory without worrying about NiFi deleting it,
you can do so by copying it with a different filename pattern.
-|nifi.flow.configuration.archive.max.time*|The lifespan of archived
flow.xml files. NiFi will delete expired archive files when it updates flow.xml
if this property is specified. Expiration is determined based on current system
time and the last modified timestamp of an archived flow.xml. If no archive
limitation is specified in nifi.properties, NiFi removes archives older than
`30 days`.
-|nifi.flow.configuration.archive.max.storage*|The total data size allowed
for the archived flow.xml files. NiFi will delete the oldest archive files
until the total archived file size becomes less than this configuration value,
if this property is specified. If no archive limitation is specified in
nifi.properties, NiFi uses `500 MB` for this.
-|nifi.flow.configuration.archive.max.count*|The number of archive files
allowed. NiFi will delete the oldest archive files so that only N latest
archives can be kept, if this property is specified.
-|nifi.flowcontroller.autoResumeState|Indicates whether -upon restart- the
components on the NiFi graph should return to their last state. The default
value is `true`.
-|nifi.flowcontroller.graceful.shutdown.period|Indicates the shutdown
period. The default value is `10 secs`.
-|nifi.flowservice.writedelay.interval|When many changes are made to the
flow.xml, this property specifies how long to wait before writing out the
changes, so as to batch the changes into a single write. The default value is
`500 ms`.
-|nifi.administrative.yield.duration|If a component allows an unexpected
exception to escape, it is considered a bug. As a result, the framework will
pause (or administratively yield) the component for this amount of time. This
is done so that the component does not use up massive amounts of system
resources, since it is known to have problems in the existing state. The
default value is `30 secs`.
-|nifi.bored.yield.duration|When a component has no work to do (i.e., is
"bored"), this is the amount of time it will wait before checking to see if it
has new data to work on. This way, it does not use up CPU resources by checking
for new work too often. When setting this property, be aware that it could add
extra latency for components that do not constantly have work to do, as once
they go into this "bored" state, they will wait this amount of time before
checking for more work. The default value is `10 ms`.
-|nifi.queue.backpressure.count|When drawing a new connection between two
components, this is the default value for that connection's back pressure
object threshold. The default is `10000` and the value must be an integer.
-|nifi.queue.backpressure.size|When drawing a new connection between two
components, this is the default value for that connection's back pressure data
size threshold. The default is `1 GB` and the value must be a data size
including the unit of measure.
-|nifi.authorizer.configuration.file*|This is the location of the file that
specifies how authorizers are defined. The default value is
`./conf/authorizers.xml`.
-|nifi.login.identity.provider.configuration.file*|This is the location of
the file that specifies how username/password authentication is performed. This
file is
+|`nifi.flow.configuration.file`*|The location of the flow configuration
file (i.e., the file that contains what is currently displayed on the NiFi
graph). The default value is `./conf/flow.xml.gz`.
+|`nifi.flow.configuration.archive.enabled`*|Specifies whether NiFi creates
a backup copy of the flow automatically when the flow is updated. The default
value is `true`.
+|`nifi.flow.configuration.archive.dir`*|The location of the archive
directory where backup copies of the _flow.xml_ are saved. The default value is
`./conf/archive`. NiFi removes old archive files to limit disk usage based on
archived file lifespan, total size, and number of files, as specified with
`nifi.flow.configuration.archive.max.time`, `max.storage` and `max.count`
properties respectively. If none of these limitation for archiving is
specified, NiFi uses default conditions, that is `30 days` for max.time and
`500 MB` for max.storage. +
+This cleanup mechanism takes into account only automatically created
archived _flow.xml_ files. If there are other files or directories in this
archive directory, NiFi will ignore them. Automatically created archives have
filename with ISO 8601 format timestamp prefix followed by
`<original-filename>`. That is
`<year><month><day>T<hour><minute><second>+<timezone offset>_<original
filename>`. For example, `20160706T160719+0900_flow.xml.gz`. NiFi checks
filenames when it cleans archive directory. If you would like to keep a
particular archive in this directory without worrying about NiFi deleting it,
you can do so by copying it with a different filename pattern.
+|`nifi.flow.configuration.archive.max.time`*|The lifespan of archived
_flow.xml_ files. NiFi will delete expired archive files when it updates
_flow.xml_ if this property is specified. Expiration is determined based on
current system time and the last modified timestamp of an archived _flow.xml_.
If no archive limitation is specified in _nifi.properties_, NiFi removes
archives older than `30 days`.
+|`nifi.flow.configuration.archive.max.storage`*|The total data size
allowed for the archived _flow.xml_ files. NiFi will delete the oldest archive
files until the total archived file size becomes less than this configuration
value, if this property is specified. If no archive limitation is specified in
_nifi.properties_, NiFi uses `500 MB` for this.
+|`nifi.flow.configuration.archive.max.count`*|The number of archive files
allowed. NiFi will delete the oldest archive files so that only N latest
archives can be kept, if this property is specified.
+|`nifi.flowcontroller.autoResumeState`|Indicates whether -upon restart-
the components on the NiFi graph should return to their last state. The default
value is `true`.
+|`nifi.flowcontroller.graceful.shutdown.period`|Indicates the shutdown
period. The default value is `10 secs`.
+|`nifi.flowservice.writedelay.interval`|When many changes are made to the
_flow.xml_, this property specifies how long to wait before writing out the
changes, so as to batch the changes into a single write. The default value is
`500 ms`.
+|`nifi.administrative.yield.duration`|If a component allows an unexpected
exception to escape, it is considered a bug. As a result, the framework will
pause (or administratively yield) the component for this amount of time. This
is done so that the component does not use up massive amounts of system
resources, since it is known to have problems in the existing state. The
default value is `30 secs`.
+|`nifi.bored.yield.duration`|When a component has no work to do (i.e., is
"bored"), this is the amount of time it will wait before checking to see if it
has new data to work on. This way, it does not use up CPU resources by checking
for new work too often. When setting this property, be aware that it could add
extra latency for components that do not constantly have work to do, as once
they go into this "bored" state, they will wait this amount of time before
checking for more work. The default value is `10 ms`.
+|`nifi.queue.backpressure.count`|When drawing a new connection between two
components, this is the default value for that connection's back pressure
object threshold. The default is `10000` and the value must be an integer.
+|`nifi.queue.backpressure.size`|When drawing a new connection between two
components, this is the default value for that connection's back pressure data
size threshold. The default is `1 GB` and the value must be a data size
including the unit of measure.
+|`nifi.authorizer.configuration.file`*|This is the location of the file
that specifies how authorizers are defined. The default value is
`./conf/authorizers.xml`.
+|`nifi.login.identity.provider.configuration.file`*|This is the location
of the file that specifies how username/password authentication is performed.
This file is
only considered if `nifi.security.user.login.identity.provider` is
configured with a provider identifier. The default value is
`./conf/login-identity-providers.xml`.
-|nifi.templates.directory*|This is the location of the directory where
flow templates are saved (for backward compatibility only). Templates are
stored in the flow.xml.gz starting with NiFi 1.0. The template directory can be
used to (bulk) import templates into the flow.xml.gz automatically on NiFi
startup. The default value is `./conf/templates`.
-|nifi.ui.banner.text|This is banner text that may be configured to display
at the top of the User Interface. It is blank by default.
-|nifi.ui.autorefresh.interval|The interval at which the User Interface
auto-refreshes. The default value is `30 secs`.
-|nifi.nar.library.directory|The location of the nar library. The default
value is `./lib` and probably should be left as is. +
+|`nifi.templates.directory`*|This is the location of the directory where
flow templates are saved (for backward compatibility only). Templates are
stored in the _flow.xml.gz_ starting with NiFi 1.0. The template directory can
be used to (bulk) import templates into the _flow.xml.gz_ automatically on NiFi
startup. The default value is `./conf/templates`.
+|`nifi.ui.banner.text`|This is banner text that may be configured to
display at the top of the User Interface. It is blank by default.
+|`nifi.ui.autorefresh.interval`|The interval at which the User Interface
auto-refreshes. The default value is `30 secs`.
+|`nifi.nar.library.directory`|The location of the nar library. The default
value is `./lib` and probably should be left as is. +
+
*NOTE*: Additional library directories can be specified by using the
*_nifi.nar.library.directory._* prefix with unique suffixes and separate paths
as values. +
+
For example, to provide two additional library locations, a user could
also specify additional properties with keys of: +
+
-nifi.nar.library.directory.lib1=/nars/lib1 +
-nifi.nar.library.directory.lib2=/nars/lib2 +
+`nifi.nar.library.directory.lib1=/nars/lib1` +
+`nifi.nar.library.directory.lib2=/nars/lib2` +
+
Providing three total locations, including `nifi.nar.library.directory`.
-|nifi.nar.working.directory|The location of the nar working directory. The
default value is `./work/nar` and probably should be left as is.
-|nifi.documentation.working.directory|The documentation working directory.
The default value is `./work/docs/components` and probably should be left as is.
-|nifi.processor.scheduling.timeout|Time to wait for a Processor's
life-cycle operation (@OnScheduled and @OnUnscheduled) to finish before other
life-cycle operation (e.g., stop) could be invoked. The default value is `1
min`.
+|`nifi.nar.working.directory`|The location of the nar working directory.
The default value is `./work/nar` and probably should be left as is.
+|`nifi.documentation.working.directory`|The documentation working
directory. The default value is `./work/docs/components` and probably should be
left as is.
+|`nifi.processor.scheduling.timeout`|Time to wait for a Processor's
life-cycle operation (@OnScheduled and @OnUnscheduled) to finish before other
life-cycle operation (e.g., stop) could be invoked. The default value is `1
min`.
--- End diff --
The life-cycle operation *stop* should be italicized or bold.
> 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)
