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 2022/03/05 01:21:34 UTC
[GitHub] [nifi] MikeThomsen opened a new pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
MikeThomsen opened a new pull request #5840:
URL: https://github.com/apache/nifi/pull/5840
…y distribution of NiFi for internal use by NiFi users.
<!--
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.
-->
Thank you for submitting a contribution to Apache NiFi.
Please provide a short description of the PR here:
#### Description of PR
_Enables X functionality; fixes bug NIFI-YYYY._
In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:
### For all changes:
- [ ] Is there a JIRA ticket associated with this PR? Is it referenced
in the commit message?
- [ ] Does your PR title start with **NIFI-XXXX** where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.
- [ ] Has your PR been rebased against the latest commit within the target branch (typically `main`)?
- [ ] Is your initial contribution a single, squashed commit? _Additional commits in response to PR reviewer feedback should be made on this branch and pushed to allow change tracking. Do not `squash` or use `--force` when pushing to allow for clean monitoring of changes._
### For code changes:
- [ ] Have you ensured that the full suite of tests is executed via `mvn -Pcontrib-check clean install` at the root `nifi` folder?
- [ ] Have you written or updated unit tests to verify your changes?
- [ ] Have you verified that the full build is successful on JDK 8?
- [ ] Have you verified that the full build is successful on JDK 11?
- [ ] If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under [ASF 2.0](http://www.apache.org/legal/resolved.html#category-a)?
- [ ] If applicable, have you updated the `LICENSE` file, including the main `LICENSE` file under `nifi-assembly`?
- [ ] If applicable, have you updated the `NOTICE` file, including the main `NOTICE` file found under `nifi-assembly`?
- [ ] If adding new Properties, have you added `.displayName` in addition to .name (programmatic access) for each of the new properties?
### For documentation related changes:
- [ ] Have you ensured that format looks appropriate for the output in which it is rendered?
### Note:
Please ensure that once the PR is submitted, you check GitHub Actions CI for build issues and submit an update to your PR as soon as possible.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1063349587
@andrewmlim I split it up as described. Should be good to go now.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1062957977
@mattyb149 updated
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1066751392
Done. Thanks @MikeThomsen !
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r822840505
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,35 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The following Maven profiles are available to administrators that want to simplify the process of building in-house distributions of Apache NiFi that contain the additional functionality that is normally excluded from the official binary releases.
+
Review comment:
Suggest adding:
[options="header,footer"]
so that table column titles are bolded.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r822853500
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,35 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The following Maven profiles are available to administrators that want to simplify the process of building in-house distributions of Apache NiFi that contain the additional functionality that is normally excluded from the official binary releases.
+
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org:[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org/#/:[Apache Atlas].
+| Apache Hive 1.1 Bundle | include-hive1_1 | Adds support for Apache Hive 1.1.X.
+| Apache Hive 3 Bundle | include-hive3 | Adds support for Apache Hive 3.X
+| Apache Ranger Bundle | include-ranger | Adds support for https://ranger.apache.org:[Apache Ranger].
+| ASN1 Support | include-asn1 | Adds support for ASN1
+| Graph Database Bundle | include-graph | Adds support for various common graph database scenarios. Support is currently for https://neo4j.com/developer/cypher/:[Cypher] and https://tinkerpop.apache.org/gremlin.html:[Gremlin]-compatible databases such as Neo4J and JanusGraph. Includes controller services that provide driver functionality and a suite of processors for ingestion and querying.
+| GRPC Bundle | include-grpc | **This profile is active in official builds and should be active** Provides support for the GRPC protocol.
+| Media Bundle | include-media | The media bundle provides functionality based on https://tika.apache.org:[Apache Tika] for extracting content and metadata from various types of binary formats supported by Apache Tika (ex. PDF, Microsoft Office).
+| Rules Engine Bundle | include-rules | Adds support for creating scripted rules engines that can be integrated into existing flows. These rules engines can provide flexibility to people who need more complex flow logic or are more comfortable with flow decision-making using custom code.
+| Snowflake Bundle | include-snowflake | Adds support for integration with the https://www.snowflake.com:[Snowflake platform].
+| SQL Reporting Bundle | include-sql-reporting | Adds reporting tasks that are designed to use SQL to update a RDBMS with metrics and other related data from Apache NiFi.
+|==================================================================================================================================================
+
+To execute build, download either Java 8 or Java 11 from https://www.adoptium.net:[Adoptium] or whichever distribution of the JDK your team uses (Adoptium is the rebranding of AdoptOpenJDK which is one of the most popular). Java 8 and 11 are the only officially supported JVMs releases. Then install https://maven.apache.org:[Apache Maven].
+
Review comment:
Remove colons from end of URLs in these paragraphs. Some work, but others don't like the NiFi download page.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r822842046
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,35 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The following Maven profiles are available to administrators that want to simplify the process of building in-house distributions of Apache NiFi that contain the additional functionality that is normally excluded from the official binary releases.
+
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org:[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org/#/:[Apache Atlas].
Review comment:
URL goes to "Page Not Found". I think the colon at the end should be removed:
https://atlas.apache.org/#/
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r822862522
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,35 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The following Maven profiles are available to administrators that want to simplify the process of building in-house distributions of Apache NiFi that contain the additional functionality that is normally excluded from the official binary releases.
+
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org:[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org/#/:[Apache Atlas].
+| Apache Hive 1.1 Bundle | include-hive1_1 | Adds support for Apache Hive 1.1.X.
+| Apache Hive 3 Bundle | include-hive3 | Adds support for Apache Hive 3.X
+| Apache Ranger Bundle | include-ranger | Adds support for https://ranger.apache.org:[Apache Ranger].
+| ASN1 Support | include-asn1 | Adds support for ASN1
+| Graph Database Bundle | include-graph | Adds support for various common graph database scenarios. Support is currently for https://neo4j.com/developer/cypher/:[Cypher] and https://tinkerpop.apache.org/gremlin.html:[Gremlin]-compatible databases such as Neo4J and JanusGraph. Includes controller services that provide driver functionality and a suite of processors for ingestion and querying.
+| GRPC Bundle | include-grpc | **This profile is active in official builds and should be active** Provides support for the GRPC protocol.
+| Media Bundle | include-media | The media bundle provides functionality based on https://tika.apache.org:[Apache Tika] for extracting content and metadata from various types of binary formats supported by Apache Tika (ex. PDF, Microsoft Office).
+| Rules Engine Bundle | include-rules | Adds support for creating scripted rules engines that can be integrated into existing flows. These rules engines can provide flexibility to people who need more complex flow logic or are more comfortable with flow decision-making using custom code.
+| Snowflake Bundle | include-snowflake | Adds support for integration with the https://www.snowflake.com:[Snowflake platform].
+| SQL Reporting Bundle | include-sql-reporting | Adds reporting tasks that are designed to use SQL to update a RDBMS with metrics and other related data from Apache NiFi.
+|==================================================================================================================================================
+
+To execute build, download either Java 8 or Java 11 from https://www.adoptium.net:[Adoptium] or whichever distribution of the JDK your team uses (Adoptium is the rebranding of AdoptOpenJDK which is one of the most popular). Java 8 and 11 are the only officially supported JVMs releases. Then install https://maven.apache.org:[Apache Maven].
+
+The next step is to download a copy of the Apache NiFi source code from the https://nifi.apache.org/download.html:[NiFi download page]. The reason you need the source build is that it includes a module called `nifi-assembly` which is the Maven module that builds a binary distribution. Expand the archive and a Maven in similar to the following example which includes GRPC, graph database and Tika support:
Review comment:
Minor edit: change "NiFi download page" to "NiFi Downloads page"
Edit: change "Expand the archive and a Maven in similar..." to "Expand the archive and run Maven. The following example will build a NiFi distribution that includes GRPC, graph database and Tika support:"
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r823338242
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,18 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The Developer Guide link:developer-guide.html#build[has a list] of optional Maven profiles that can be activated to build a binary distribution of NiFi with these extra capabilities.
+
+To execute build, download either Java 8 or Java 11 from https://www.adoptium.net[Adoptium] or whichever distribution of the JDK your team uses (Adoptium is the rebranding of AdoptOpenJDK which is one of the most popular). Java 8 and 11 are the only officially supported JVMs releases. Then install https://maven.apache.org[Apache Maven].
Review comment:
Change "JVMs" to "JVM".
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,18 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The Developer Guide link:developer-guide.html#build[has a list] of optional Maven profiles that can be activated to build a binary distribution of NiFi with these extra capabilities.
+
+To execute build, download either Java 8 or Java 11 from https://www.adoptium.net[Adoptium] or whichever distribution of the JDK your team uses (Adoptium is the rebranding of AdoptOpenJDK which is one of the most popular). Java 8 and 11 are the only officially supported JVMs releases. Then install https://maven.apache.org[Apache Maven].
Review comment:
Change "JVMs" to "JVM".
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1063156195
> > Is the Admin Guide the best place for this?
>
> I'm not sure there's an easy answer for this. Maybe duplicate it in the developer guide. The reason I added it to the admin guide was that our devops team deploys custom builds that I produce using a few extra bundle flags. There's definitely an admin angle to this now given how many packages we have that are not part of the convenience binary builds anymore.
My thoughts:
-We should definitely include this content in the Developer Guide.
-So we could have duplicate information in both Admin Guide and Developer Guide. Or we could have more of a brief summary paragraph in the Admin Guide and provide a link to the full content in the Developer Guide. I'm fine with either option.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r822847457
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,35 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The following Maven profiles are available to administrators that want to simplify the process of building in-house distributions of Apache NiFi that contain the additional functionality that is normally excluded from the official binary releases.
+
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org:[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org/#/:[Apache Atlas].
Review comment:
All the extraneous colons should be removed from the URLs in the table.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r822862522
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,35 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The following Maven profiles are available to administrators that want to simplify the process of building in-house distributions of Apache NiFi that contain the additional functionality that is normally excluded from the official binary releases.
+
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org:[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org/#/:[Apache Atlas].
+| Apache Hive 1.1 Bundle | include-hive1_1 | Adds support for Apache Hive 1.1.X.
+| Apache Hive 3 Bundle | include-hive3 | Adds support for Apache Hive 3.X
+| Apache Ranger Bundle | include-ranger | Adds support for https://ranger.apache.org:[Apache Ranger].
+| ASN1 Support | include-asn1 | Adds support for ASN1
+| Graph Database Bundle | include-graph | Adds support for various common graph database scenarios. Support is currently for https://neo4j.com/developer/cypher/:[Cypher] and https://tinkerpop.apache.org/gremlin.html:[Gremlin]-compatible databases such as Neo4J and JanusGraph. Includes controller services that provide driver functionality and a suite of processors for ingestion and querying.
+| GRPC Bundle | include-grpc | **This profile is active in official builds and should be active** Provides support for the GRPC protocol.
+| Media Bundle | include-media | The media bundle provides functionality based on https://tika.apache.org:[Apache Tika] for extracting content and metadata from various types of binary formats supported by Apache Tika (ex. PDF, Microsoft Office).
+| Rules Engine Bundle | include-rules | Adds support for creating scripted rules engines that can be integrated into existing flows. These rules engines can provide flexibility to people who need more complex flow logic or are more comfortable with flow decision-making using custom code.
+| Snowflake Bundle | include-snowflake | Adds support for integration with the https://www.snowflake.com:[Snowflake platform].
+| SQL Reporting Bundle | include-sql-reporting | Adds reporting tasks that are designed to use SQL to update a RDBMS with metrics and other related data from Apache NiFi.
+|==================================================================================================================================================
+
+To execute build, download either Java 8 or Java 11 from https://www.adoptium.net:[Adoptium] or whichever distribution of the JDK your team uses (Adoptium is the rebranding of AdoptOpenJDK which is one of the most popular). Java 8 and 11 are the only officially supported JVMs releases. Then install https://maven.apache.org:[Apache Maven].
+
+The next step is to download a copy of the Apache NiFi source code from the https://nifi.apache.org/download.html:[NiFi download page]. The reason you need the source build is that it includes a module called `nifi-assembly` which is the Maven module that builds a binary distribution. Expand the archive and a Maven in similar to the following example which includes GRPC, graph database and Tika support:
Review comment:
Minor edit: change "NiFi download page" to "NiFi Downloads page"
Edit: change "Expand the archive and a Maven in similar..." to "Expand the archive and run Maven. The following example will build a NiFi distribution that includes GRPC, graph database and Tika support:
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1062942616
@pvillard31 could you do a quick review?
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r823338020
##########
File path: nifi-docs/src/main/asciidoc/developer-guide.adoc
##########
@@ -2582,6 +2582,33 @@ Sometimes it may be desirable to deprecate a component. Whenever this occurs the
As you can see, the alternatives can be used to define and array of alternative Components, while classNames can be
used to represent the similar content through an array of strings.
+[[build]]
+== Build Options
+=== Maven Profiles
+
+[options="header,footer"]
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org[Apache Atlas].
+| Apache Hive 1.1 Bundle | include-hive1_1 | Adds support for Apache Hive 1.1.X.
+| Apache Hive 3 Bundle | include-hive3 | Adds support for Apache Hive 3.X
+| Apache Ranger Bundle | include-ranger | Adds support for https://ranger.apache.org[Apache Ranger].
+| ASN1 Support | include-asn1 | Adds support for ASN1
+| Contribution Check | contrib-check | Runs various quality checks that are required to be accepted before a contribution can be accepted into the core NiFi code base.
+| Graph Database Bundle | include-graph | Adds support for various common graph database scenarios. Support is currently for https://neo4j.com/developer/cypher[Cypher] and https://tinkerpop.apache.org/gremlin.html[Gremlin]-compatible databases such as Neo4J and JanusGraph. Includes controller services that provide driver functionality and a suite of processors for ingestion and querying.
+| GRPC Bundle | include-grpc | **This profile is active in official builds and should be active** Provides support for the GRPC protocol.
+| Media Bundle | include-media | The media bundle provides functionality based on https://tika.apache.org[Apache Tika] for extracting content and metadata from various types of binary formats supported by Apache Tika (ex. PDF, Microsoft Office).
+| Rules Engine Bundle | include-rules | Adds support for creating scripted rules engines that can be integrated into existing flows. These rules engines can provide flexibility to people who need more complex flow logic or are more comfortable with flow decision-making using custom code.
+| Snowflake Bundle | include-snowflake | Adds support for integration with the https://www.snowflake.com[Snowflake platform].
+| SQL Reporting Bundle | include-sql-reporting | Adds reporting tasks that are designed to use SQL to update a RDBMS with metrics and other related data from Apache NiFi.
+|==================================================================================================================================================
+
+=== Standard Build Instructions
+
+The following command is used to generae a standard binary distribution of Apache NiFi:
Review comment:
Correct spelling to "generate"
##########
File path: nifi-docs/src/main/asciidoc/developer-guide.adoc
##########
@@ -2582,6 +2582,33 @@ Sometimes it may be desirable to deprecate a component. Whenever this occurs the
As you can see, the alternatives can be used to define and array of alternative Components, while classNames can be
used to represent the similar content through an array of strings.
+[[build]]
+== Build Options
+=== Maven Profiles
+
+[options="header,footer"]
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org[Apache Atlas].
+| Apache Hive 1.1 Bundle | include-hive1_1 | Adds support for Apache Hive 1.1.X.
+| Apache Hive 3 Bundle | include-hive3 | Adds support for Apache Hive 3.X
+| Apache Ranger Bundle | include-ranger | Adds support for https://ranger.apache.org[Apache Ranger].
+| ASN1 Support | include-asn1 | Adds support for ASN1
+| Contribution Check | contrib-check | Runs various quality checks that are required to be accepted before a contribution can be accepted into the core NiFi code base.
+| Graph Database Bundle | include-graph | Adds support for various common graph database scenarios. Support is currently for https://neo4j.com/developer/cypher[Cypher] and https://tinkerpop.apache.org/gremlin.html[Gremlin]-compatible databases such as Neo4J and JanusGraph. Includes controller services that provide driver functionality and a suite of processors for ingestion and querying.
+| GRPC Bundle | include-grpc | **This profile is active in official builds and should be active** Provides support for the GRPC protocol.
+| Media Bundle | include-media | The media bundle provides functionality based on https://tika.apache.org[Apache Tika] for extracting content and metadata from various types of binary formats supported by Apache Tika (ex. PDF, Microsoft Office).
+| Rules Engine Bundle | include-rules | Adds support for creating scripted rules engines that can be integrated into existing flows. These rules engines can provide flexibility to people who need more complex flow logic or are more comfortable with flow decision-making using custom code.
+| Snowflake Bundle | include-snowflake | Adds support for integration with the https://www.snowflake.com[Snowflake platform].
+| SQL Reporting Bundle | include-sql-reporting | Adds reporting tasks that are designed to use SQL to update a RDBMS with metrics and other related data from Apache NiFi.
+|==================================================================================================================================================
+
+=== Standard Build Instructions
+
+The following command is used to generae a standard binary distribution of Apache NiFi:
Review comment:
Correct spelling to "generate"
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1063654940
Just suggested two minor edits. But otherwise looks good!
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1063074897
> Is the Admin Guide the best place for this?
I'm not sure there's an easy answer for this. Maybe duplicate it in the developer guide. The reason I added it to the admin guide was that our devops team deploys custom builds that I produce using a few extra bundle flags. There's definitely an admin angle to this now given how many packages we have that are not part of the convenience binary builds anymore.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1063077647
Sorry, I missed the review request. Taking a look now...
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1059963009
@andrewmlim can your review?
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] mattyb149 commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
mattyb149 commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r822675225
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,35 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The following Maven profiles are available to administrators that want to simplify the process of building in-house distributions of Apache NiFi that contain the additional functionality that is normally excluded from the official binary releases.
+
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org:[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org/#/:[Apache Atlas].
+| Apache Hive 1.1 Bundle | include-hive1_1 | Adds support for Apache Hive 1.1.X.
+| Apache Hive 3 Bundle | include-hive3 | Adds support for Apache Hive 3.X
+| Apache Ranger Bundle | include-ranger | Adds support for https://ranger.apache.org:[Apache Ranger].
+| ASN1 Support | include-asn1 | Adds support for ASN1
+| Graph Database Bundle | include-graph | Adds support for various common graph database scenarios. Support is currently for https://neo4j.com/developer/cypher/:[Cypher] and https://tinkerpop.apache.org/gremlin.html:[Gremlin]-compatible databases such as Neo4J and JanusGraph. Includes controller services that provide driver functionality and a suite of processors for ingestion and querying.
+| GRPC Bundle | include-grpc | **This profile is active in official builds and should be active** Provides support for the GRPC protocol.
+| Media Bundle | include-media | The media bundle provides functionality based on https://tika.apache.org:[Apache Tika] for extracting content and metadata from various types of binary formats supported by Apache Tika (ex. PDF, Microsoft Office).
+| Rules Engine Bundle | include-rules | Adds support for creating scripted rules engines that can be integrated into existing flows. These rules engines can provide flexibility to people who need more complex flow logic or are more comfortable with flow decision-making using custom code.
+| Snowflake Bundle | include-snowflake | Adds support for integration with the https://www.snowflake.com:[Snowflake platform].
+| SQL Reporting Bundle | include-sql-reporting | Adds reporting tasks that are designed to use SQL to update a RDBMS with metrics and other related data from Apache NiFi.
+|==================================================================================================================================================
+
+To execute build, download either Java 8 or Java 11 from https://www.adoptium.net:[Adoptium] or whichever distribution of the JDK your team uses (Adoptium is the rebranding of AdoptOpenJDK which is one of the most popular). Java 8 and 11 are the only officially supported JVMs releases. Then install https://maven.apache.org:[Apache Maven].
+
+The next step is to download a copy of the Apache NiFi source code from the https://nifi.apache.org/download.html:[NiFi download page]. The reason you need the source build is that it includes a module called `nifi-assembly` which is the Maven module that builds a binary distribution. Expand the archive and a Maven in similar to the following example which includes GRPC, graph database and Tika support:
+
+`cd <nifi_source_folder>/nifi-assembly`
+
+`mvn install -Pinclude-grpc,include-graph,include-media`
Review comment:
Should this have a `clean` goal as well?
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] mattyb149 commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
mattyb149 commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1063070094
Is the Admin Guide the best place for this? It doesn't mention any building of the artifacts, all that is discussed in the Developer Guide. @pvillard31 @andrewmlim what are your thoughts?
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1063306109
> Or we could have more of a brief summary paragraph in the Admin Guide and provide a link
I like that approach better.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1067417725
Thanks!
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim merged pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim merged pull request #5840:
URL: https://github.com/apache/nifi/pull/5840
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1064129342
@andrewmlim changes made.
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#issuecomment-1065616373
@andrewmlim since joe is canceling the release vote, can we close this out?
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] andrewmlim commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
andrewmlim commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r823339042
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,18 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The Developer Guide link:developer-guide.html#build[has a list] of optional Maven profiles that can be activated to build a binary distribution of NiFi with these extra capabilities.
+
+To execute build, download either Java 8 or Java 11 from https://www.adoptium.net[Adoptium] or whichever distribution of the JDK your team uses (Adoptium is the rebranding of AdoptOpenJDK which is one of the most popular). Java 8 and 11 are the only officially supported JVMs releases. Then install https://maven.apache.org[Apache Maven].
Review comment:
Just suggested two minor edits. But otherwise looks good!
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [nifi] MikeThomsen commented on a change in pull request #5840: NIFI-9765 Added documentation that covers how to build a custom binar…
Posted by GitBox <gi...@apache.org>.
MikeThomsen commented on a change in pull request #5840:
URL: https://github.com/apache/nifi/pull/5840#discussion_r822676313
##########
File path: nifi-docs/src/main/asciidoc/administration-guide.adoc
##########
@@ -76,6 +76,35 @@ NOTE: For security purposes, when no security configuration is provided NiFi wil
See the <<system_properties>> section of this guide for more information about configuring NiFi repositories and configuration files.
+== Build a Custom Distribution
+
+The binary build of Apache NiFi that is provided by the Apache mirrors does not contain every NAR file that is part of the official release. This is due to size constraints imposed by the mirrors to reduce the expenses associated with hosting such a large project. The following Maven profiles are available to administrators that want to simplify the process of building in-house distributions of Apache NiFi that contain the additional functionality that is normally excluded from the official binary releases.
+
+|==================================================================================================================================================
+| Package | Maven Profile | Description
+| Apache Accumulo Bundle | include-accumulo | Adds support for https://accumulo.apache.org:[Apache Accumulo].
+| Apache Atlas Bundle | include-atlas | Adds support for the Apache Atlas data governance tool. The functionality from this bundle is based around reporting tasks that integrate with https://atlas.apache.org/#/:[Apache Atlas].
+| Apache Hive 1.1 Bundle | include-hive1_1 | Adds support for Apache Hive 1.1.X.
+| Apache Hive 3 Bundle | include-hive3 | Adds support for Apache Hive 3.X
+| Apache Ranger Bundle | include-ranger | Adds support for https://ranger.apache.org:[Apache Ranger].
+| ASN1 Support | include-asn1 | Adds support for ASN1
+| Graph Database Bundle | include-graph | Adds support for various common graph database scenarios. Support is currently for https://neo4j.com/developer/cypher/:[Cypher] and https://tinkerpop.apache.org/gremlin.html:[Gremlin]-compatible databases such as Neo4J and JanusGraph. Includes controller services that provide driver functionality and a suite of processors for ingestion and querying.
+| GRPC Bundle | include-grpc | **This profile is active in official builds and should be active** Provides support for the GRPC protocol.
+| Media Bundle | include-media | The media bundle provides functionality based on https://tika.apache.org:[Apache Tika] for extracting content and metadata from various types of binary formats supported by Apache Tika (ex. PDF, Microsoft Office).
+| Rules Engine Bundle | include-rules | Adds support for creating scripted rules engines that can be integrated into existing flows. These rules engines can provide flexibility to people who need more complex flow logic or are more comfortable with flow decision-making using custom code.
+| Snowflake Bundle | include-snowflake | Adds support for integration with the https://www.snowflake.com:[Snowflake platform].
+| SQL Reporting Bundle | include-sql-reporting | Adds reporting tasks that are designed to use SQL to update a RDBMS with metrics and other related data from Apache NiFi.
+|==================================================================================================================================================
+
+To execute build, download either Java 8 or Java 11 from https://www.adoptium.net:[Adoptium] or whichever distribution of the JDK your team uses (Adoptium is the rebranding of AdoptOpenJDK which is one of the most popular). Java 8 and 11 are the only officially supported JVMs releases. Then install https://maven.apache.org:[Apache Maven].
+
+The next step is to download a copy of the Apache NiFi source code from the https://nifi.apache.org/download.html:[NiFi download page]. The reason you need the source build is that it includes a module called `nifi-assembly` which is the Maven module that builds a binary distribution. Expand the archive and a Maven in similar to the following example which includes GRPC, graph database and Tika support:
+
+`cd <nifi_source_folder>/nifi-assembly`
+
+`mvn install -Pinclude-grpc,include-graph,include-media`
Review comment:
Good catch. That would help
--
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.
To unsubscribe, e-mail: issues-unsubscribe@nifi.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org