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 2021/11/05 10:02:11 UTC

[GitHub] [nifi] laurentedel opened a new pull request #5511: Update README.md

laurentedel opened a new pull request #5511:
URL: https://github.com/apache/nifi/pull/5511


   how to find generated credentials in the logs
   adding default passwords security policy
   
   <!--
     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] laurentedel commented on pull request #5511: Update README.md

Posted by GitBox <gi...@apache.org>.
laurentedel commented on pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#issuecomment-962034332


   This commit aims to resolve NIFI-9367 for Docker image usage details and clarification


-- 
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] laurentedel commented on pull request #5511: NIFI-9367 Update README.md

Posted by GitBox <gi...@apache.org>.
laurentedel commented on pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#issuecomment-963963962


   Thank you for all your very valuable suggestions @exceptionfactory !


-- 
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] laurentedel commented on pull request #5511: Update README.md

Posted by GitBox <gi...@apache.org>.
laurentedel commented on pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#issuecomment-962034332


   This commit aims to resolve NIFI-9367 for Docker image usage details and clarification


-- 
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] laurentedel commented on pull request #5511: Update README.md

Posted by GitBox <gi...@apache.org>.
laurentedel commented on pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#issuecomment-962034332


   This commit aims to resolve NIFI-9367 for Docker image usage details and clarification


-- 
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] exceptionfactory commented on pull request #5511: Update README.md

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#issuecomment-961934733


   Thanks for the pull request @laurentedel! As noted in the Pull Request checklist, each change requires an associated Jira issue number, so please open an issue in the [Apache NiFi Jira board](https://issues.apache.org/jira/browse/NIFI). You can also join the [Developers mailing list](https://nifi.apache.org/mailing_lists.html) and request Jira contributor access so that you can assign the issue to yourself. After opening the Jira issue, you can update this pull request to include the Jira number.


-- 
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] exceptionfactory commented on pull request #5511: Update README.md

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#issuecomment-961934733


   Thanks for the pull request @laurentedel! As noted in the Pull Request checklist, each change requires an associated Jira issue number, so please open an issue in the [Apache NiFi Jira board](https://issues.apache.org/jira/browse/NIFI). You can also join the [Developers mailing list](https://nifi.apache.org/mailing_lists.html) and request Jira contributor access so that you can assign the issue to yourself. After opening the Jira issue, you can update this pull request to include the Jira number.


-- 
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] exceptionfactory commented on pull request #5511: Update README.md

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#issuecomment-961934733


   Thanks for the pull request @laurentedel! As noted in the Pull Request checklist, each change requires an associated Jira issue number, so please open an issue in the [Apache NiFi Jira board](https://issues.apache.org/jira/browse/NIFI). You can also join the [Developers mailing list](https://nifi.apache.org/mailing_lists.html) and request Jira contributor access so that you can assign the issue to yourself. After opening the Jira issue, you can update this pull request to include the Jira number.


-- 
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] exceptionfactory commented on a change in pull request #5511: NIFI-9367 Update README.md

Posted by GitBox <gi...@apache.org>.
exceptionfactory commented on a change in pull request #5511:
URL: https://github.com/apache/nifi/pull/5511#discussion_r744739089



##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -77,6 +77,14 @@ The minimum to run a NiFi instance is as follows:
 
 This will provide a running instance, exposing the instance UI to the host system on at port 8443,
 viewable at `https://localhost:8443/nifi`.
+It will generate credentials, which could be found in the docker logs after the startup phase (about a minute):

Review comment:
       Recommend adjusting the wording as follows, similar to the main project README:
   
   ```suggestion
   The default configuration generates a random username and password on startup. NiFi writes the generated credentials to the application log.
   
   The following command can be used to find the generated credentials on operating systems with grep installed:
   ```

##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -86,7 +94,7 @@ Environment variables can be used to set the NiFi communication ports and hostna
       -e NIFI_WEB_HTTPS_PORT='9443' \
       apache/nifi:latest
 
-Single User Authentication credentials can be specified using environment variables as follows:
+The esiest way to run NiFi is probably with specifying Single User Authentication credentials using environment variables as follows:

Review comment:
       Recommend reverting this change as the existing wording is already clear.
   

##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -77,6 +77,14 @@ The minimum to run a NiFi instance is as follows:
 
 This will provide a running instance, exposing the instance UI to the host system on at port 8443,
 viewable at `https://localhost:8443/nifi`.
+It will generate credentials, which could be found in the docker logs after the startup phase (about a minute):
+
+    docker logs nifi | grep Generated
+
+the credentials will then be displayed such as
+
+    Generated Username [5ae5ed8e-b695-4589-bfb0-aee8989a08b3]
+    Generated Password [YJZD3kP8SFzF+SbRmHlcTBifiZTvS6bb]

Review comment:
       ```suggestion
       Generated Username [USERNAME]
       Generated Password [PASSWORD]
   ```

##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -95,6 +103,7 @@ Single User Authentication credentials can be specified using environment variab
       -e SINGLE_USER_CREDENTIALS_PASSWORD=ctsBtRBKHRAx69EqUghvvgEvjnaLjFEB \
       apache/nifi:latest
 
+Please note that the password must be 12 chars minimmum, or a new one will be generated (see above to find it in the logs)

Review comment:
       The wording should be adjusted to correct the spelling of `minimum`, and spelling out `characters` would be helpful.
   ```suggestion
   Please note that the password must be 12 characters minimum, otherwise NiFi will generate a random username and password.
   ```

##########
File path: nifi-docker/dockerhub/README.md
##########
@@ -77,6 +77,14 @@ The minimum to run a NiFi instance is as follows:
 
 This will provide a running instance, exposing the instance UI to the host system on at port 8443,
 viewable at `https://localhost:8443/nifi`.
+It will generate credentials, which could be found in the docker logs after the startup phase (about a minute):
+
+    docker logs nifi | grep Generated
+
+the credentials will then be displayed such as

Review comment:
       Following the project README:
   ```suggestion
   NiFi logs the generated credentials as follows:
   ```




-- 
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] exceptionfactory closed pull request #5511: NIFI-9367 Update README.md

Posted by GitBox <gi...@apache.org>.
exceptionfactory closed pull request #5511:
URL: https://github.com/apache/nifi/pull/5511


   


-- 
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