From b22df30ccb9259fbfb7d0f31286851fad411dba4 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Patrick=20Sodr=C3=A9?= Date: Fri, 22 Apr 2022 22:29:07 -0400 Subject: [PATCH] Update README.md --- README.md | 30 +++++++++++++++++++++++++----- 1 file changed, 25 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index dfd85c0..d89ffe6 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # nifi-cognito-bundle NiFi Authorization Extension using AWS Cognito -## Build Instructions - - Ensure you have AWS Credentials available +## Build/Install Instructions +1. Ensure you have AWS Credentials available ``` mvn clean install - cp nifi-cognito-nar/target/*.nar $NIFI_HOME/extensions ``` +2. The binaries are located in `nifi-cognito-nar/target` and `nifi-registry-cognito-assembly` ## Usage 1. Add new `userGroupProvider` and `accessPolicyProvider` elements to `authorizers.xml`. @@ -34,6 +34,9 @@ NiFi Authorization Extension using AWS Cognito cognito-configurable-user-group-provider co.zeroae.nifi.authorization.cognito.CognitoUserGroupProvider + ./conf/bootstrap-aws.conf us-east-1_XXXXXXX 50 @@ -54,6 +57,9 @@ NiFi Authorization Extension using AWS Cognito - User Pool - The *same* Cognito User Pool Id where the Users and Groups are stored. + - Tenant Id - An id to attach to every Access Policy stored in the User Pool. Must be the same for nodes + of the same cluster. If two clusters share the same tenant id then they will share the access policies. + - User Group Provider - The identifier of the Cognito User Group Provider defined above. - Initial Admin Identity - The identity of the initial admin user. The user must already exist @@ -69,6 +75,9 @@ NiFi Authorization Extension using AWS Cognito cognito-access-policy-provider co.zeroae.nifi.authorization.cognito.CognitoAccessPolicyProvider + ./conf/bootstrap-aws.conf us-east-1_edD0TJEd0 cognito-configurable-user-group-provider @@ -77,10 +86,21 @@ NiFi Authorization Extension using AWS Cognito ``` -2. Configure an Identity Mapping in `nifi.properties` + +2. Updadte `nifi.properties` ```properties + nifi.nar.library.directory.cognito=/nifi-cognito-bundle/nifi-cognito-nar/target nifi.security.identity.mapping.pattern.dn=^CN=(.*?), OU=(.*?)$ nifi.security.identity.mapping.value.dn=$1@$2 nifi.security.identity.mapping.transform.dn=LOWER ``` -3. Start NiFi \ No newline at end of file + +3. Update `nifi-registry.properties` + ```properties + nifi.registry.extension.dir.cognito=/nifi-cognito-bundle/nifi-registry-cognito-assembly/target/cognito/lib + nifi.registry.security.identity.mapping.pattern.dn=^CN=(.*?), OU=(.*?)$ + nifi.registry.security.identity.mapping.value.dn=$1@$2 + nifi.registry.security.identity.mapping.transform.dn=LOWER + ``` + +4. Start NiFi and the Registry \ No newline at end of file