This is an automated email from the ASF dual-hosted git repository.
bbende pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/nifi-registry.git
The following commit(s) were added to refs/heads/master by this push:
new 63845dd NIFIREG-316 Update docs for more granular Proxy policies,
Public Buckets and Bundle Overwrite
63845dd is described below
commit 63845dd9e0d660efd2b19ad7d5a575122c215d63
Author: Andrew Lim <[email protected]>
AuthorDate: Fri Aug 23 16:04:43 2019 -0400
NIFIREG-316 Update docs for more granular Proxy policies, Public Buckets
and Bundle Overwrite
---
.../images/bucket_nav_allow_bundle_overwrite.png | Bin 0 -> 74539 bytes
.../asciidoc/images/bucket_nav_make_public.png | Bin 0 -> 74649 bytes
.../main/asciidoc/images/bucket_nav_name_edit.png | Bin 61106 -> 73116 bytes
.../main/asciidoc/images/delete_bucket_policy.png | Bin 69265 -> 94634 bytes
.../src/main/asciidoc/images/group_added.png | Bin 86646 -> 92440 bytes
.../src/main/asciidoc/images/new_bucket_dialog.png | Bin 19275 -> 22630 bytes
.../asciidoc/images/new_bucket_policy_added.png | Bin 60618 -> 83416 bytes
.../asciidoc/images/new_bucket_policy_create.png | Bin 61821 -> 72899 bytes
.../asciidoc/images/remove_group_from_user.png | Bin 107323 -> 99590 bytes
.../asciidoc/images/remove_user_from_group.png | Bin 111803 -> 112981 bytes
.../images/select_users_new_group_added.png | Bin 106978 -> 111636 bytes
.../main/asciidoc/images/test_bucket_dialog.png | Bin 71005 -> 78443 bytes
.../main/asciidoc/images/user_nav_add_to_group.png | Bin 92238 -> 97855 bytes
.../main/asciidoc/images/user_nav_name_edit.png | Bin 77991 -> 83547 bytes
.../asciidoc/images/user_special_privileges.png | Bin 115491 -> 98657 bytes
.../src/main/asciidoc/user-guide.adoc | 24 +++++++++++++++++++--
16 files changed, 22 insertions(+), 2 deletions(-)
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_allow_bundle_overwrite.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_allow_bundle_overwrite.png
new file mode 100644
index 0000000..61cdb36
Binary files /dev/null and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_allow_bundle_overwrite.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_make_public.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_make_public.png
new file mode 100644
index 0000000..95a4589
Binary files /dev/null and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_make_public.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_name_edit.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_name_edit.png
index 8724e78..249b37f 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_name_edit.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_name_edit.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy.png
index 35e56a9..1238f8d 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/group_added.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/group_added.png
index fc71971..7627f6e 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/group_added.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/group_added.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_dialog.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_dialog.png
index 9bb7627..ac0a41e 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_dialog.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_dialog.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_added.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_added.png
index a18e8c8..578ffd3 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_added.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_added.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_create.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_create.png
index e29aa66..9a6aedd 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_create.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_create.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/remove_group_from_user.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/remove_group_from_user.png
index 023ccde..c1ccef3 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/remove_group_from_user.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/remove_group_from_user.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/remove_user_from_group.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/remove_user_from_group.png
index c1c7497..2270cae 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/remove_user_from_group.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/remove_user_from_group.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/select_users_new_group_added.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/select_users_new_group_added.png
index 51ed584..b9dc4b4 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/select_users_new_group_added.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/select_users_new_group_added.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/test_bucket_dialog.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/test_bucket_dialog.png
index e9143b4..0250717 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/test_bucket_dialog.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/test_bucket_dialog.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_nav_add_to_group.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_nav_add_to_group.png
index 68653df..6c95898 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_nav_add_to_group.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_nav_add_to_group.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_nav_name_edit.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_nav_name_edit.png
index bd19121..006300b 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_nav_name_edit.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_nav_name_edit.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_special_privileges.png
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_special_privileges.png
index eda0b43..2bf6410 100644
Binary files
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_special_privileges.png
and
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/images/user_special_privileges.png
differ
diff --git
a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/user-guide.adoc
b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/user-guide.adoc
index 6320ae6..69c79da 100644
--- a/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/user-guide.adoc
+++ b/nifi-registry-core/nifi-registry-docs/src/main/asciidoc/user-guide.adoc
@@ -160,6 +160,8 @@ image::new_bucket_button.png["New Bucket Button"]
+
image::new_bucket_dialog.png["New Bucket Dialog"]
+NOTE: Check "Make publicly available" to allow read access to items in the
bucket by unauthenticated users. This will override any specific
<<bucket_policies,bucket policies>> granting read access.
+
NOTE: To quickly create multiple buckets, check "Keep this dialog open after
creating bucket".
@@ -190,6 +192,23 @@ image::manage_bucket.png["Manage Bucket"]
+
image::bucket_nav_name_edit.png["Edit Bucket Name"]
+=== Make a Bucket Publicly Visible
+To allow read access to items in a bucket by unauthenticated users, select the
"Make publicly visible" checkbox.
+
+image::bucket_nav_make_public.png["Make Bucket Public"]
+
+This setting will override any specific policies granting read access to the
bucket.
+
+=== Allow Bundles in a Bucket to be Overwritten
+To allow released bundles in a bucket to be overwritten, select the "Allow
bundle overwrite" checkbox.
+
+image::bucket_nav_allow_bundle_overwrite.png["Allow Bundle Overwrite"]
+
+Currently, the only supported bundle type is a
link:https://nifi.apache.org/docs/nifi-docs/html/developer-guide.html#nars[NiFi
Archive (NAR)]. By default, buckets do not allow the re-release of released
NARs. This setting explicitly allows the same version of a NAR to be uploaded
to a bucket.
+
+For more information on bundles, see the <<manage_bundles>> section.
+
+[[bucket_policies]]
=== Bucket Policies
Bucket policies define user privileges on buckets/flows in the Registry and in
NiFi. The available permissions are:
@@ -298,7 +317,7 @@ Special privileges are additional permissions that allow a
user to manage or acc
* *Can manage policies* - Allow a user to grant all registry users read,
write, and delete permission to a bucket.
-* *Can proxy user requests* - Allow a connected system (e.g., NiFi) to process
requests of authorized users of that system.
+* *Can proxy user requests* - Allow a connected system (e.g., NiFi) to process
requests of authorized users of that system. For example, if dev and prod NiFi
clusters are connected to the same NiFi Registry instance, privileges can be
set to allow the dev NiFi cluster to only update versioned flows while limiting
the prod NiFi to only download flows.
==== Grant Special Privileges to a User
1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row
of the user.
@@ -366,6 +385,7 @@ image::remove_user_from_group.png["Remove User From Group"]
Editing group names, deleting groups, adding policies to/deleting policies
from groups and granting special privileges to groups follow similar procedures
described earlier for corresponding user level actions.
+[[manage_bundles]]
== Manage Bundles
Bundles can be managed through the REST API.
@@ -419,4 +439,4 @@ An example of using `curl` to download
`my-processors-1.0.0.nar` by id and versi
=== Additional Actions
-For additional actions that can be performed related to bundles, please
consult the link:rest-api.html[REST API documentation].
\ No newline at end of file
+For additional actions that can be performed related to bundles, please
consult the link:rest-api.html[REST API documentation].
