You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@nifi.apache.org by GitBox <gi...@apache.org> on 2020/09/15 10:58:11 UTC
[GitHub] [nifi] sdairs opened a new pull request #4529: NIFI-7580-Add documentation around autoloading NARs
sdairs opened a new pull request #4529:
URL: https://github.com/apache/nifi/pull/4529
Adds documenation to the Administration guide for installing custom processors & using the autoload features
https://issues.apache.org/jira/browse/NIFI-7580
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] pvillard31 commented on a change in pull request #4529: NIFI-7580-Add documentation around autoloading NARs
Posted by GitBox <gi...@apache.org>.
pvillard31 commented on a change in pull request #4529:
URL: https://github.com/apache/nifi/pull/4529#discussion_r490148601
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -3676,3 +3676,65 @@ In your new NiFi installation:
3. After confirming your new NiFi instances are stable and working as expected, the old installation can be removed.
NOTE: If the original NiFi was setup to run as a service, update any symlinks or service scripts to point to the new NiFi version executables.
+
+
+== Processor Locations
+
+[[processor-location-options]]
+=== Available Configuration Options
+
+NiFi provides 3 configuration options for processor locations. Namely:
+
+ nifi.nar.library.directory
+ nifi.nar.library.directory.<custom>
+ nifi.nar.library.autoload.directory
+
+NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `./lib`, then the final path is `/var/lib/nifi/lib`.
+
+The `nifi.nar.library.directory` is used for the default location for provided NiFi processors. It is not recommended to use this for custom processors as these could be lost during a NiFi upgrade. For example:
+
+ nifi.nar.library.directory=/lib
Review comment:
```suggestion
nifi.nar.library.directory=./lib
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] pvillard31 commented on pull request #4529: NIFI-7580-Add documentation around autoloading NARs
Posted by GitBox <gi...@apache.org>.
pvillard31 commented on pull request #4529:
URL: https://github.com/apache/nifi/pull/4529#issuecomment-694154325
Merged to main, not closing the JIRA as the versioning consideration has not been included and might be important in the context of a development cluster where someone would be trying changes in a custom NAR without changing the name of it (and this would not be auto-loaded as a new version of the NAR).
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] pvillard31 commented on a change in pull request #4529: NIFI-7580-Add documentation around autoloading NARs
Posted by GitBox <gi...@apache.org>.
pvillard31 commented on a change in pull request #4529:
URL: https://github.com/apache/nifi/pull/4529#discussion_r488625959
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -3676,3 +3676,65 @@ In your new NiFi installation:
3. After confirming your new NiFi instances are stable and working as expected, the old installation can be removed.
NOTE: If the original NiFi was setup to run as a service, update any symlinks or service scripts to point to the new NiFi version executables.
+
+
+== Processor Locations
+
+[[processor-location-options]]
+=== Available Configuration Options
+
+NiFi provides 3 configuration options for processor locations. Namely:
+
+ nifi.nar.library.directory
+ nifi.nar.library.directory.<custom>
+ nifi.nar.library.autoload.directory
+
+NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `/lib`, then the final path is `/var/lib/nifi/lib`.
+
+The `nifi.nar.library.directory` is used for the default location for provided NiFi processors. It is not recommended to use this for custom processors as these could be lost during a NiFi upgrade.
+For example:
+ nifi.nar.library.directory=/lib
Review comment:
```suggestion
The `nifi.nar.library.directory` is used for the default location for provided NiFi processors. It is not recommended to use this for custom processors as these could be lost during a NiFi upgrade. For example:
nifi.nar.library.directory=/lib
```
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -3676,3 +3676,65 @@ In your new NiFi installation:
3. After confirming your new NiFi instances are stable and working as expected, the old installation can be removed.
NOTE: If the original NiFi was setup to run as a service, update any symlinks or service scripts to point to the new NiFi version executables.
+
+
+== Processor Locations
+
+[[processor-location-options]]
+=== Available Configuration Options
+
+NiFi provides 3 configuration options for processor locations. Namely:
+
+ nifi.nar.library.directory
+ nifi.nar.library.directory.<custom>
+ nifi.nar.library.autoload.directory
+
+NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `/lib`, then the final path is `/var/lib/nifi/lib`.
Review comment:
```suggestion
NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `./lib`, then the final path is `/var/lib/nifi/lib`.
```
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -3676,3 +3676,65 @@ In your new NiFi installation:
3. After confirming your new NiFi instances are stable and working as expected, the old installation can be removed.
NOTE: If the original NiFi was setup to run as a service, update any symlinks or service scripts to point to the new NiFi version executables.
+
+
+== Processor Locations
+
+[[processor-location-options]]
+=== Available Configuration Options
+
+NiFi provides 3 configuration options for processor locations. Namely:
+
+ nifi.nar.library.directory
+ nifi.nar.library.directory.<custom>
+ nifi.nar.library.autoload.directory
+
+NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `/lib`, then the final path is `/var/lib/nifi/lib`.
+
+The `nifi.nar.library.directory` is used for the default location for provided NiFi processors. It is not recommended to use this for custom processors as these could be lost during a NiFi upgrade.
+For example:
+ nifi.nar.library.directory=/lib
+
+The `nifi.nar.library.directory.<custom>` allows the admin to provide multiple arbritary paths for NiFi to locate custom processors. A unique property identifier must append the property for each unique path.
+For example:
+ nifi.nar.library.directory.myCustomLibs=/my-custom-nars/lib
+ nifi.nar.library.directory.otherCustomLibs=/other-custom-nars/lib
+
+The `nifi.nar.library.autoload.directory` is used by the autoload feature, where NiFi can automatically load new processors added to the configured path without requiring a restart.
+For example:
+ nifi.nar.library.autoload.directory=/autoload/lib
+
+=== Installing Custom Processors
+
+This section describes the original process for installing custom processors that requires a restart to NiFi. To use the Autoloading feature, see the below <<autoloading-processors>> section.
+
+Firstly, we will configure a directory for the custom processors. See <<processor-location-options>> for more about these configuration options.
+
+ nifi.nar.library.directory.myCustomLibs=/my-custom-nars/lib
+
+Ensure that this directory exists and has appropriate permissions for the nifi user and group.
+
+Now, we must place our custom processor nar in the configured directory. The configured directory is relative to the NiFi Home directory; for example, let us say that our NiFi Home Dir is `/var/lib/nifi`, we would place our custom processor nar in `/var/lib/nifi/my-custom-nars/lib`.
+
+Ensure that the file has appropriate permissions for the nifi user and group.
+
+Restart NiFi and the custom processor should now be available when adding a new Processor to your flow.
+
+[[autoloading-processors]]
+=== Autoloading Custom Processors
+
+This section describes the process to use the Autoloading feature for custom processors.
+
+To use the autoloading feature, the `nifi.nar.library.autoload.directory` property must be configured to point at the desired directory.
+By default, this points at `./extensions`.
Review comment:
```suggestion
To use the autoloading feature, the `nifi.nar.library.autoload.directory` property must be configured to point at the desired directory. By default, this points at `./extensions`.
```
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -3676,3 +3676,65 @@ In your new NiFi installation:
3. After confirming your new NiFi instances are stable and working as expected, the old installation can be removed.
NOTE: If the original NiFi was setup to run as a service, update any symlinks or service scripts to point to the new NiFi version executables.
+
+
+== Processor Locations
+
+[[processor-location-options]]
+=== Available Configuration Options
+
+NiFi provides 3 configuration options for processor locations. Namely:
+
+ nifi.nar.library.directory
+ nifi.nar.library.directory.<custom>
+ nifi.nar.library.autoload.directory
+
+NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `/lib`, then the final path is `/var/lib/nifi/lib`.
+
+The `nifi.nar.library.directory` is used for the default location for provided NiFi processors. It is not recommended to use this for custom processors as these could be lost during a NiFi upgrade.
+For example:
+ nifi.nar.library.directory=/lib
+
+The `nifi.nar.library.directory.<custom>` allows the admin to provide multiple arbritary paths for NiFi to locate custom processors. A unique property identifier must append the property for each unique path.
+For example:
+ nifi.nar.library.directory.myCustomLibs=/my-custom-nars/lib
+ nifi.nar.library.directory.otherCustomLibs=/other-custom-nars/lib
+
+The `nifi.nar.library.autoload.directory` is used by the autoload feature, where NiFi can automatically load new processors added to the configured path without requiring a restart.
+For example:
+ nifi.nar.library.autoload.directory=/autoload/lib
Review comment:
```suggestion
The `nifi.nar.library.autoload.directory` is used by the autoload feature, where NiFi can automatically load new processors added to the configured path without requiring a restart. For example:
nifi.nar.library.autoload.directory=./autoload/lib
```
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -3676,3 +3676,65 @@ In your new NiFi installation:
3. After confirming your new NiFi instances are stable and working as expected, the old installation can be removed.
NOTE: If the original NiFi was setup to run as a service, update any symlinks or service scripts to point to the new NiFi version executables.
+
+
+== Processor Locations
+
+[[processor-location-options]]
+=== Available Configuration Options
+
+NiFi provides 3 configuration options for processor locations. Namely:
+
+ nifi.nar.library.directory
+ nifi.nar.library.directory.<custom>
+ nifi.nar.library.autoload.directory
+
+NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `/lib`, then the final path is `/var/lib/nifi/lib`.
+
+The `nifi.nar.library.directory` is used for the default location for provided NiFi processors. It is not recommended to use this for custom processors as these could be lost during a NiFi upgrade.
+For example:
+ nifi.nar.library.directory=/lib
+
+The `nifi.nar.library.directory.<custom>` allows the admin to provide multiple arbritary paths for NiFi to locate custom processors. A unique property identifier must append the property for each unique path.
+For example:
+ nifi.nar.library.directory.myCustomLibs=/my-custom-nars/lib
+ nifi.nar.library.directory.otherCustomLibs=/other-custom-nars/lib
+
+The `nifi.nar.library.autoload.directory` is used by the autoload feature, where NiFi can automatically load new processors added to the configured path without requiring a restart.
+For example:
+ nifi.nar.library.autoload.directory=/autoload/lib
+
+=== Installing Custom Processors
+
+This section describes the original process for installing custom processors that requires a restart to NiFi. To use the Autoloading feature, see the below <<autoloading-processors>> section.
+
+Firstly, we will configure a directory for the custom processors. See <<processor-location-options>> for more about these configuration options.
+
+ nifi.nar.library.directory.myCustomLibs=/my-custom-nars/lib
+
+Ensure that this directory exists and has appropriate permissions for the nifi user and group.
+
+Now, we must place our custom processor nar in the configured directory. The configured directory is relative to the NiFi Home directory; for example, let us say that our NiFi Home Dir is `/var/lib/nifi`, we would place our custom processor nar in `/var/lib/nifi/my-custom-nars/lib`.
+
+Ensure that the file has appropriate permissions for the nifi user and group.
+
+Restart NiFi and the custom processor should now be available when adding a new Processor to your flow.
+
+[[autoloading-processors]]
+=== Autoloading Custom Processors
+
+This section describes the process to use the Autoloading feature for custom processors.
+
+To use the autoloading feature, the `nifi.nar.library.autoload.directory` property must be configured to point at the desired directory.
+By default, this points at `./extensions`.
+
+For example:
+ nifi.nar.library.autoload.directory=./extensions
Review comment:
```suggestion
For example:
nifi.nar.library.autoload.directory=./extensions
```
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -3676,3 +3676,65 @@ In your new NiFi installation:
3. After confirming your new NiFi instances are stable and working as expected, the old installation can be removed.
NOTE: If the original NiFi was setup to run as a service, update any symlinks or service scripts to point to the new NiFi version executables.
+
+
+== Processor Locations
+
+[[processor-location-options]]
+=== Available Configuration Options
+
+NiFi provides 3 configuration options for processor locations. Namely:
+
+ nifi.nar.library.directory
+ nifi.nar.library.directory.<custom>
+ nifi.nar.library.autoload.directory
+
+NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `/lib`, then the final path is `/var/lib/nifi/lib`.
+
+The `nifi.nar.library.directory` is used for the default location for provided NiFi processors. It is not recommended to use this for custom processors as these could be lost during a NiFi upgrade.
+For example:
+ nifi.nar.library.directory=/lib
+
+The `nifi.nar.library.directory.<custom>` allows the admin to provide multiple arbritary paths for NiFi to locate custom processors. A unique property identifier must append the property for each unique path.
+For example:
+ nifi.nar.library.directory.myCustomLibs=/my-custom-nars/lib
+ nifi.nar.library.directory.otherCustomLibs=/other-custom-nars/lib
Review comment:
```suggestion
The `nifi.nar.library.directory.<custom>` allows the admin to provide multiple arbritary paths for NiFi to locate custom processors. A unique property identifier must append the property for each unique path. For example:
nifi.nar.library.directory.myCustomLibs=./my-custom-nars/lib
nifi.nar.library.directory.otherCustomLibs=./other-custom-nars/lib
```
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -3676,3 +3676,65 @@ In your new NiFi installation:
3. After confirming your new NiFi instances are stable and working as expected, the old installation can be removed.
NOTE: If the original NiFi was setup to run as a service, update any symlinks or service scripts to point to the new NiFi version executables.
+
+
+== Processor Locations
+
+[[processor-location-options]]
+=== Available Configuration Options
+
+NiFi provides 3 configuration options for processor locations. Namely:
+
+ nifi.nar.library.directory
+ nifi.nar.library.directory.<custom>
+ nifi.nar.library.autoload.directory
+
+NOTE: Paths set using these options are relative to the NiFi Home Directory. For example, if the NiFi Home Directory is `/var/lib/nifi`, and the Library Directory is `/lib`, then the final path is `/var/lib/nifi/lib`.
+
+The `nifi.nar.library.directory` is used for the default location for provided NiFi processors. It is not recommended to use this for custom processors as these could be lost during a NiFi upgrade.
+For example:
+ nifi.nar.library.directory=/lib
+
+The `nifi.nar.library.directory.<custom>` allows the admin to provide multiple arbritary paths for NiFi to locate custom processors. A unique property identifier must append the property for each unique path.
+For example:
+ nifi.nar.library.directory.myCustomLibs=/my-custom-nars/lib
+ nifi.nar.library.directory.otherCustomLibs=/other-custom-nars/lib
+
+The `nifi.nar.library.autoload.directory` is used by the autoload feature, where NiFi can automatically load new processors added to the configured path without requiring a restart.
+For example:
+ nifi.nar.library.autoload.directory=/autoload/lib
+
+=== Installing Custom Processors
+
+This section describes the original process for installing custom processors that requires a restart to NiFi. To use the Autoloading feature, see the below <<autoloading-processors>> section.
+
+Firstly, we will configure a directory for the custom processors. See <<processor-location-options>> for more about these configuration options.
+
+ nifi.nar.library.directory.myCustomLibs=/my-custom-nars/lib
Review comment:
```suggestion
nifi.nar.library.directory.myCustomLibs=./my-custom-nars/lib
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] pvillard31 commented on pull request #4529: NIFI-7580-Add documentation around autoloading NARs
Posted by GitBox <gi...@apache.org>.
pvillard31 commented on pull request #4529:
URL: https://github.com/apache/nifi/pull/4529#issuecomment-692685202
From a content point of view, it LGTM but since the JIRA was assigned to @alopresto, requesting his review to make sure we cover everything or if follow up JIRAs are required.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] asfgit closed pull request #4529: NIFI-7580-Add documentation around autoloading NARs
Posted by GitBox <gi...@apache.org>.
asfgit closed pull request #4529:
URL: https://github.com/apache/nifi/pull/4529
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] alopresto commented on pull request #4529: NIFI-7580-Add documentation around autoloading NARs
Posted by GitBox <gi...@apache.org>.
alopresto commented on pull request #4529:
URL: https://github.com/apache/nifi/pull/4529#issuecomment-692944706
Unfortunately with some competing priorities, I don't have time to look at this now. Assuming the docs don't make things _more_ confusing, something is better than nothing in my mind. Thanks for contributing this. Pierre, please proceed without me.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org