Repository: nifi-registry Updated Branches: refs/heads/master 64211451c -> 00aa7e239
NIFIREG-84 Added screenshots to User Guide and made text edits This closes #70. Signed-off-by: Bryan Bende <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/nifi-registry/repo Commit: http://git-wip-us.apache.org/repos/asf/nifi-registry/commit/00aa7e23 Tree: http://git-wip-us.apache.org/repos/asf/nifi-registry/tree/00aa7e23 Diff: http://git-wip-us.apache.org/repos/asf/nifi-registry/diff/00aa7e23 Branch: refs/heads/master Commit: 00aa7e23965cb88361a1a660c51a0ca7e7915862 Parents: 6421145 Author: Andrew Lim <[email protected]> Authored: Wed Dec 27 18:37:21 2017 -0500 Committer: Bryan Bende <[email protected]> Committed: Wed Dec 27 19:29:25 2017 -0500 ---------------------------------------------------------------------- .../main/asciidoc/images/add_user_button.png | Bin 0 -> 59897 bytes .../main/asciidoc/images/add_user_dialog.png | Bin 0 -> 17823 bytes .../images/add_user_to_groups_dialog.png | Bin 0 -> 29156 bytes .../src/main/asciidoc/images/bucket_menu.png | Bin 0 -> 54430 bytes .../asciidoc/images/bucket_nav_name_edit.png | Bin 0 -> 61106 bytes .../asciidoc/images/buckets_filter_by_name.png | Bin 0 -> 49859 bytes .../asciidoc/images/buckets_sort_by_name.png | Bin 0 -> 59859 bytes .../asciidoc/images/check_multiple_buckets.png | Bin 0 -> 62281 bytes .../asciidoc/images/check_multiple_users.png | Bin 0 -> 60431 bytes .../main/asciidoc/images/create_new_group.png | Bin 0 -> 63792 bytes .../asciidoc/images/create_new_group_dialog.png | Bin 0 -> 21564 bytes .../asciidoc/images/delete_bucket_dialog.png | Bin 0 -> 17736 bytes .../asciidoc/images/delete_bucket_policy.png | Bin 0 -> 69265 bytes .../images/delete_bucket_policy_dialog.png | Bin 0 -> 20881 bytes .../asciidoc/images/delete_bucket_single.png | Bin 0 -> 62781 bytes .../asciidoc/images/delete_buckets_dialog.png | Bin 0 -> 19357 bytes .../asciidoc/images/delete_multiple_buckets.png | Bin 0 -> 65092 bytes .../asciidoc/images/delete_multiple_users.png | Bin 0 -> 64823 bytes .../main/asciidoc/images/delete_user_dialog.png | Bin 0 -> 15769 bytes .../main/asciidoc/images/delete_user_single.png | Bin 0 -> 61305 bytes .../images/delete_users_groups_dialog.png | Bin 0 -> 26343 bytes .../main/asciidoc/images/flow_change_log.png | Bin 0 -> 77032 bytes .../main/asciidoc/images/flow_delete_action.png | Bin 0 -> 69145 bytes .../asciidoc/images/flow_delete_confirm.png | Bin 0 -> 46657 bytes .../src/main/asciidoc/images/flows_all.png | Bin 0 -> 47974 bytes .../asciidoc/images/flows_filter_by_name.png | Bin 0 -> 37004 bytes .../main/asciidoc/images/flows_sort_menu.png | Bin 0 -> 52627 bytes .../src/main/asciidoc/images/group_added.png | Bin 0 -> 86646 bytes .../src/main/asciidoc/images/iconDelete.png | Bin 0 -> 695 bytes .../src/main/asciidoc/images/iconHelp.png | Bin 0 -> 970 bytes .../src/main/asciidoc/images/iconManage.png | Bin 0 -> 748 bytes .../src/main/asciidoc/images/iconSettings.png | Bin 0 -> 887 bytes .../src/main/asciidoc/images/loginRegistry.png | Bin 0 -> 15560 bytes .../src/main/asciidoc/images/manage_bucket.png | Bin 0 -> 63105 bytes .../src/main/asciidoc/images/manage_user.png | Bin 0 -> 62620 bytes .../main/asciidoc/images/new_bucket_button.png | Bin 0 -> 61133 bytes .../main/asciidoc/images/new_bucket_dialog.png | Bin 0 -> 19275 bytes .../asciidoc/images/new_bucket_policy_added.png | Bin 0 -> 60618 bytes .../images/new_bucket_policy_create.png | Bin 0 -> 61821 bytes .../new_bucket_policy_user_permission.png | Bin 0 -> 28727 bytes .../images/nifi-registry-components.png | Bin 0 -> 68544 bytes .../images/nifi_user1_template.snagproj | Bin 0 -> 9758309 bytes .../asciidoc/images/nifi_user_template.snagproj | Bin 0 -> 11249836 bytes .../asciidoc/images/remove_group_from_user.png | Bin 0 -> 107323 bytes .../asciidoc/images/remove_user_from_group.png | Bin 0 -> 111803 bytes .../images/select_users_create_new_group.png | Bin 0 -> 78363 bytes .../select_users_create_new_group_dialog.png | Bin 0 -> 21597 bytes .../images/select_users_new_group_added.png | Bin 0 -> 106978 bytes .../asciidoc/images/user_nav_add_to_group.png | Bin 0 -> 92238 bytes .../main/asciidoc/images/user_nav_name_edit.png | Bin 0 -> 77991 bytes .../asciidoc/images/user_special_privileges.png | Bin 0 -> 115491 bytes .../asciidoc/images/users_filter_by_name.png | Bin 0 -> 50482 bytes .../asciidoc/images/users_non_configurable.png | Bin 0 -> 27133 bytes .../main/asciidoc/images/users_sort_by_name.png | Bin 0 -> 59613 bytes .../src/main/asciidoc/user-guide.adoc | 369 ++++++++++--------- 55 files changed, 198 insertions(+), 171 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/add_user_button.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/add_user_button.png b/nifi-registry-docs/src/main/asciidoc/images/add_user_button.png new file mode 100644 index 0000000..69b29fa Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/add_user_button.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/add_user_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/add_user_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/add_user_dialog.png new file mode 100644 index 0000000..0e1d6ea Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/add_user_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/add_user_to_groups_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/add_user_to_groups_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/add_user_to_groups_dialog.png new file mode 100644 index 0000000..8890bbb Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/add_user_to_groups_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/bucket_menu.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/bucket_menu.png b/nifi-registry-docs/src/main/asciidoc/images/bucket_menu.png new file mode 100644 index 0000000..29a52dd Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/bucket_menu.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_name_edit.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_name_edit.png b/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_name_edit.png new file mode 100644 index 0000000..8724e78 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/bucket_nav_name_edit.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/buckets_filter_by_name.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/buckets_filter_by_name.png b/nifi-registry-docs/src/main/asciidoc/images/buckets_filter_by_name.png new file mode 100644 index 0000000..ed1c65a Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/buckets_filter_by_name.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/buckets_sort_by_name.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/buckets_sort_by_name.png b/nifi-registry-docs/src/main/asciidoc/images/buckets_sort_by_name.png new file mode 100644 index 0000000..4d40f9a Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/buckets_sort_by_name.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/check_multiple_buckets.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/check_multiple_buckets.png b/nifi-registry-docs/src/main/asciidoc/images/check_multiple_buckets.png new file mode 100644 index 0000000..cf08d44 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/check_multiple_buckets.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/check_multiple_users.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/check_multiple_users.png b/nifi-registry-docs/src/main/asciidoc/images/check_multiple_users.png new file mode 100644 index 0000000..230b5b6 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/check_multiple_users.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/create_new_group.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/create_new_group.png b/nifi-registry-docs/src/main/asciidoc/images/create_new_group.png new file mode 100644 index 0000000..288c588 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/create_new_group.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/create_new_group_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/create_new_group_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/create_new_group_dialog.png new file mode 100644 index 0000000..f29fc9f Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/create_new_group_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_dialog.png new file mode 100644 index 0000000..7e43135 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy.png b/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy.png new file mode 100644 index 0000000..35e56a9 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy_dialog.png new file mode 100644 index 0000000..6b6e237 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_policy_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_single.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_single.png b/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_single.png new file mode 100644 index 0000000..9fc4a2a Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_bucket_single.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_buckets_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_buckets_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/delete_buckets_dialog.png new file mode 100644 index 0000000..cc55a83 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_buckets_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_multiple_buckets.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_multiple_buckets.png b/nifi-registry-docs/src/main/asciidoc/images/delete_multiple_buckets.png new file mode 100644 index 0000000..8b5f9b2 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_multiple_buckets.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_multiple_users.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_multiple_users.png b/nifi-registry-docs/src/main/asciidoc/images/delete_multiple_users.png new file mode 100644 index 0000000..31f4ad2 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_multiple_users.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_user_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_user_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/delete_user_dialog.png new file mode 100644 index 0000000..35f2253 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_user_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_user_single.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_user_single.png b/nifi-registry-docs/src/main/asciidoc/images/delete_user_single.png new file mode 100644 index 0000000..82599e4 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_user_single.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/delete_users_groups_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/delete_users_groups_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/delete_users_groups_dialog.png new file mode 100644 index 0000000..0c00989 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/delete_users_groups_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/flow_change_log.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/flow_change_log.png b/nifi-registry-docs/src/main/asciidoc/images/flow_change_log.png new file mode 100644 index 0000000..ece10bd Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/flow_change_log.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/flow_delete_action.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/flow_delete_action.png b/nifi-registry-docs/src/main/asciidoc/images/flow_delete_action.png new file mode 100644 index 0000000..5ae40a9 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/flow_delete_action.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/flow_delete_confirm.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/flow_delete_confirm.png b/nifi-registry-docs/src/main/asciidoc/images/flow_delete_confirm.png new file mode 100644 index 0000000..491f4d3 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/flow_delete_confirm.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/flows_all.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/flows_all.png b/nifi-registry-docs/src/main/asciidoc/images/flows_all.png new file mode 100644 index 0000000..0faef8f Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/flows_all.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/flows_filter_by_name.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/flows_filter_by_name.png b/nifi-registry-docs/src/main/asciidoc/images/flows_filter_by_name.png new file mode 100644 index 0000000..5d53d73 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/flows_filter_by_name.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/flows_sort_menu.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/flows_sort_menu.png b/nifi-registry-docs/src/main/asciidoc/images/flows_sort_menu.png new file mode 100644 index 0000000..517a762 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/flows_sort_menu.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/group_added.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/group_added.png b/nifi-registry-docs/src/main/asciidoc/images/group_added.png new file mode 100644 index 0000000..fc71971 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/group_added.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/iconDelete.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/iconDelete.png b/nifi-registry-docs/src/main/asciidoc/images/iconDelete.png new file mode 100644 index 0000000..cf4d048 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/iconDelete.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/iconHelp.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/iconHelp.png b/nifi-registry-docs/src/main/asciidoc/images/iconHelp.png new file mode 100644 index 0000000..601ec42 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/iconHelp.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/iconManage.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/iconManage.png b/nifi-registry-docs/src/main/asciidoc/images/iconManage.png new file mode 100644 index 0000000..d70dedf Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/iconManage.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/iconSettings.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/iconSettings.png b/nifi-registry-docs/src/main/asciidoc/images/iconSettings.png new file mode 100644 index 0000000..693255c Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/iconSettings.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/loginRegistry.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/loginRegistry.png b/nifi-registry-docs/src/main/asciidoc/images/loginRegistry.png new file mode 100644 index 0000000..9fa3f9d Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/loginRegistry.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/manage_bucket.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/manage_bucket.png b/nifi-registry-docs/src/main/asciidoc/images/manage_bucket.png new file mode 100644 index 0000000..e2159da Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/manage_bucket.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/manage_user.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/manage_user.png b/nifi-registry-docs/src/main/asciidoc/images/manage_user.png new file mode 100644 index 0000000..d8174c0 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/manage_user.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/new_bucket_button.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/new_bucket_button.png b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_button.png new file mode 100644 index 0000000..147d5d0 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_button.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/new_bucket_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/new_bucket_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_dialog.png new file mode 100644 index 0000000..9bb7627 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_added.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_added.png b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_added.png new file mode 100644 index 0000000..a18e8c8 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_added.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_create.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_create.png b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_create.png new file mode 100644 index 0000000..e29aa66 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_create.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_user_permission.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_user_permission.png b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_user_permission.png new file mode 100644 index 0000000..3367009 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/new_bucket_policy_user_permission.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/nifi-registry-components.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/nifi-registry-components.png b/nifi-registry-docs/src/main/asciidoc/images/nifi-registry-components.png new file mode 100644 index 0000000..2225ab6 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/nifi-registry-components.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/nifi_user1_template.snagproj ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/nifi_user1_template.snagproj b/nifi-registry-docs/src/main/asciidoc/images/nifi_user1_template.snagproj new file mode 100644 index 0000000..5fd34a8 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/nifi_user1_template.snagproj differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/nifi_user_template.snagproj ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/nifi_user_template.snagproj b/nifi-registry-docs/src/main/asciidoc/images/nifi_user_template.snagproj new file mode 100644 index 0000000..9aee06d Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/nifi_user_template.snagproj differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/remove_group_from_user.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/remove_group_from_user.png b/nifi-registry-docs/src/main/asciidoc/images/remove_group_from_user.png new file mode 100644 index 0000000..023ccde Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/remove_group_from_user.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/remove_user_from_group.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/remove_user_from_group.png b/nifi-registry-docs/src/main/asciidoc/images/remove_user_from_group.png new file mode 100644 index 0000000..c1c7497 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/remove_user_from_group.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/select_users_create_new_group.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/select_users_create_new_group.png b/nifi-registry-docs/src/main/asciidoc/images/select_users_create_new_group.png new file mode 100644 index 0000000..b49e9be Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/select_users_create_new_group.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/select_users_create_new_group_dialog.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/select_users_create_new_group_dialog.png b/nifi-registry-docs/src/main/asciidoc/images/select_users_create_new_group_dialog.png new file mode 100644 index 0000000..33f9142 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/select_users_create_new_group_dialog.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/select_users_new_group_added.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/select_users_new_group_added.png b/nifi-registry-docs/src/main/asciidoc/images/select_users_new_group_added.png new file mode 100644 index 0000000..51ed584 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/select_users_new_group_added.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/user_nav_add_to_group.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/user_nav_add_to_group.png b/nifi-registry-docs/src/main/asciidoc/images/user_nav_add_to_group.png new file mode 100644 index 0000000..68653df Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/user_nav_add_to_group.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/user_nav_name_edit.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/user_nav_name_edit.png b/nifi-registry-docs/src/main/asciidoc/images/user_nav_name_edit.png new file mode 100644 index 0000000..bd19121 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/user_nav_name_edit.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/user_special_privileges.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/user_special_privileges.png b/nifi-registry-docs/src/main/asciidoc/images/user_special_privileges.png new file mode 100644 index 0000000..eda0b43 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/user_special_privileges.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/users_filter_by_name.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/users_filter_by_name.png b/nifi-registry-docs/src/main/asciidoc/images/users_filter_by_name.png new file mode 100644 index 0000000..7b994a3 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/users_filter_by_name.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/users_non_configurable.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/users_non_configurable.png b/nifi-registry-docs/src/main/asciidoc/images/users_non_configurable.png new file mode 100644 index 0000000..f2500a1 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/users_non_configurable.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/images/users_sort_by_name.png ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/images/users_sort_by_name.png b/nifi-registry-docs/src/main/asciidoc/images/users_sort_by_name.png new file mode 100644 index 0000000..4548813 Binary files /dev/null and b/nifi-registry-docs/src/main/asciidoc/images/users_sort_by_name.png differ http://git-wip-us.apache.org/repos/asf/nifi-registry/blob/00aa7e23/nifi-registry-docs/src/main/asciidoc/user-guide.adoc ---------------------------------------------------------------------- diff --git a/nifi-registry-docs/src/main/asciidoc/user-guide.adoc b/nifi-registry-docs/src/main/asciidoc/user-guide.adoc index 6f7b661..4566c39 100644 --- a/nifi-registry-docs/src/main/asciidoc/user-guide.adoc +++ b/nifi-registry-docs/src/main/asciidoc/user-guide.adoc @@ -22,9 +22,11 @@ Apache NiFi Team <[email protected]> Introduction ------------ -Apache NiFi Registryâa subproject of Apache NiFiâis a complementary application that provides a central location for storage and management of shared resources across one or more instances of NiFi and/or MiNiFi. The first implementation of the Registry supports versioned flows. Process group level dataflows created in NiFi can be placed under version control and stored in a registry. The registry organizes where flows are stored and manages the permissions users have to create, modify or delete them. +Apache NiFi Registryâa subproject of Apache NiFiâis a complementary application that provides a central location for storage and management of shared resources across one or more instances of NiFi and/or MiNiFi. -See the link:administration-guide.html[System Administratorâs Guide] for information about system requirements, installation, and configuration. Once NiFi Registry is installed, use a supported web browser to view the UI. +The first implementation of the Registry supports versioned flows. Process group level dataflows created in NiFi can be placed under version control and stored in a registry. The registry organizes where flows are stored and manages the permissions to access, create, modify or delete them. + +See the link:administration-guide.html[System Administratorâs Guide] for information about Registry system requirements, installation, and configuration. Once NiFi Registry is installed, use a supported web browser to view the UI. Browser Support @@ -50,7 +52,7 @@ While the UI may run successfully in unsupported browsers, it is not actively te === Viewing the UI in Variably Sized Browsers In most environments, all of the UI is visible in your browser. However, the UI has a responsive design that allows you to scroll through screens as needed, in smaller sized browsers or tablet environments. -In environments where your browser width is less than 800 pixels and the height less than 600 pixels, portions of the UI may become unavailable. +NOTE: The minimum recommended screen size is 1080px X 445px. Terminology ----------- @@ -58,334 +60,359 @@ Terminology *Bucket*: A container that stores and organizes flows. -*Policy*: Defines a user's ability to read, write and/or delete flows in a bucket. - -*Administrator*: A NiFi Registry user who has permissions to add, remove and modify flows, buckets, users and policies. +*Policy*: Defines a user or group's ability to import, view, commit changes and/or delete flows. [[User_Interface]] NiFi Registry User Interface ---------------------------- -The NiFi Registry UI displays the shared resources available and provides mechanisms for creating and administering users, groups, buckets and policies. +The NiFi Registry UI displays the shared resources available and provides mechanisms for creating and administering users/groups, buckets and policies. When the application is started, the user is able to navigate to the UI by going to the default address of `http://<hostname>:18080/nifi-registry` in a web browser. There are no permissions configured by default, so anyone is able to view and modify the flows and buckets. For information on securing the system, see the link:administration-guide.html[System Administratorâs Guide]. -When an administrator navigates to the UI for the first time, the registry is empty as there are no resources available to share yet: +When an administrator navigates to the UI for the first time, the registry is empty as there are no flow resources available to share yet: -<SCREENSHOT> - -The Buckets menu is available at the top left of the screen. It allows the user to display flows based on which bucket they are contained in. On the top right of the screen is the Administration button (wrench icon) which accesses functionality for managing users, groups, buckets and policies. +image::nifi-registry-components.png["NiFi Registry Components"] +The Buckets menu is available at the top left of the screen. It allows the user to display flows based on which bucket they are contained in. On the top right of the screen is the Settings button (image:iconSettings.png["Settings Icon"]) which accesses functionality for managing users, groups, buckets and policies. Next to the Settings button is the Help button (image:iconHelp.png["Help Icon"]) which accesses the NiFi Registry Documentation. [[logging-in]] Logging In ---------- -If NiFi Registry is configured to run securely, users will be able to request access to the DataFlow. For information on configuring NiFi Registry to run securely, see the link:administration-guide.html[System Administratorâs Guide]. If NiFi Registry supports anonymous access, users will be given access accordingly and given an option to log in. +If NiFi Registry is configured to run securely, users will have to be granted permissions to buckets by an administrator. For information on configuring NiFi Registry to run securely, see the link:administration-guide.html[System Administratorâs Guide]. If the user is logging in with their username/password they will be presented with a screen to do so. -<SCREENSHOT> +image::loginRegistry.png["NiFi Registry Login"] -Navigating Flows ----------------- +Manage Flows +------------ ==== View a Flow -Flows in all buckets are listed in the main window of the UI by default. +Flows in all buckets are listed in the main window of the UI by default. If the registry is secured, only the flows in the buckets that the user has access to are listed. -<SCREENSHOT> +image::flows_all.png["All Flows"] -To see the flows in a particular bucket, select the Bucket from the drop-down menu at the top left of the UI. +To see the flows in a particular bucket, select that bucket from the drop-down menu at the top left of the UI. -<SCREENSHOT> +image::bucket_menu.png["Bucket Menu"] Click on a flow to see its Description and Change Log: -<SCREENSHOT> +image::flow_change_log.png["Flow Change Log"] -The Change Log includes all versions that were saved for a flow. Clicking on the version reveals details about the date/time when the version was saved, which user committed the save and any comments entered by the user. - -<SCREENSHOT> +The Change Log includes all versions that were saved for a flow. Clicking on the version reveals details about when the version was saved, which user committed the save, and any comments entered by the user. ===== Sorting & Filtering Flows Flows can be sorted alphabetically by Name (ascending or descending) or by Update (newest or oldest) using the drop-down at the top right of the UI. -<SCREENSHOT> +image::flows_sort_menu.png["Flows Sort Menu"] + +The flow list can be filtered by: + +* flow name +* flow description +* flow ID +* bucket name +* bucket ID -The flow list can also be filtered using the filter field. +Here is an example filtering by flow name: -<SCREENSHOT> +image::flows_filter_by_name.png["Flows Filter By Name"] ==== Delete a Flow -1. Click on a flow. +To delete a flow from the registry: + +1. Click on the flow to see its details. 2. Select the "Actions" drop-down and click the "Delete" menu option. -<SCREENSHOT> +image::flow_delete_action.png["Flow Delete Action"] -3. Select "Delete" in the confirmation dialog. +[start=3] +3. Select "Delete" to confirm. -<SCREENSHOT> +image::flow_delete_confirm.png["Flow Delete Confirm"] -WARNING: It is possible to delete a flow that is actively being used. +WARNING: It is possible to delete a flow that is actively being used in NiFi. Manage Buckets -------------- +To manage buckets, enter the Administration section of the Registry by clicking the Settings button (image:iconSettings.png["Settings Icon"]) on the top right of the UI. The Buckets window appears by default. + +==== Sorting & Filtering Buckets +Buckets can be sorted alphabetically by Name (ascending or descending) using the up/down arrows. + +image::buckets_sort_by_name.png["Buckets Sort By Name"] + +The buckets listed can be filtered by: + +* bucket name +* bucket description +* bucket ID + +Here is an example filtering by bucket name: + +image::buckets_filter_by_name.png["Buckets Filter By Name"] ==== Create a Bucket -1. Enter the Administration section of the Registry by clicking the Administration button (wrench icon) on the top right of the UI. The Bucket window appears by default. +1. Select the "New Bucket" button. -<SCREENSHOT> +image::new_bucket_button.png["New Bucket Button"] -2. Select the "New Bucket" button. Enter the desired bucket name and select the "Create" button. +[start=2] +2. Enter the desired bucket name and select the "Create" button. -<SCREENSHOT> +image::new_bucket_dialog.png["New Bucket Dialog"] -NOTE: To quickly create multiple buckets, check the "Keep this dialog open after creating bucket" checkbox. +NOTE: To quickly create multiple buckets, check "Keep this dialog open after creating bucket". ==== Delete a Bucket -1. Select the Delete button (trash icon) in the row of the bucket. +1. Select the Delete button (image:iconDelete.png["Delete Icon"]) in the row of the bucket. -<SCREENSHOT> +image::delete_bucket_single.png["Delete Single Bucket"] +[start=2] 2. From the Delete Bucket dialog, select "Delete". -<SCREENSHOT> +image::delete_bucket_dialog.png["Delete Bucket Dialog"] ==== Delete Multiple Buckets -1. Select the checkboxes in the row of the desired buckets to delete. +1. Select the checkboxes in the rows of the desired buckets to delete. + +image::check_multiple_buckets.png["Check Multiple Buckets"] -<SCREENSHOT> +[start=2] +2. Select the "Actions" drop-down and click the "Delete" option. -2. Select the "Actions" drop-down and click the "Delete selected buckets" option. +image::delete_multiple_buckets.png["Delete Multiple Buckets"] -<SCREENSHOT> +[start=3] +3. From the Delete Buckets dialog, select "Delete". +image::delete_buckets_dialog.png["Delete Buckets Dialog"] -==== Configure a Bucket -===== Edit a Bucket Name -1. Select the Edit button (pencil icon) in the row of the bucket. +==== Edit a Bucket Name +1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row of the bucket. -<SCREENSHOT> +image::manage_bucket.png["Manage Bucket"] +[start=2] 2. Enter a new name for the bucket and select the "Save" button. -<SCREENSHOT> +image::bucket_nav_name_edit.png["Edit Bucket Name"] -===== Create a Bucket Policy -1. Select the Edit button (pencil icon) in the row of the bucket. +==== Bucket Policies +Bucket policies define user privileges on buckets/flows in the Registry and in NiFi. The available permissions are: -<SCREENSHOT> +* *All* - In the Registry, the assigned user is able to view and delete flows in the bucket. In NiFi, the selected user is able to import flows from the bucket and commit changes to flows in the bucket. -2. Select the "New Policy" button. +* *Read* - In the Registry, the assigned user is able to view flows in the bucket. In NiFi, the selected user is able to import flows from the bucket. + +* *Write* - In NiFi, the assigned user is able to commit changes to flows in the bucket. + +* *Delete* - In the Registry, the assigned user is able to delete flows in the bucket. -<SCREENSHOT> +NOTE: Users would typically have Read permissions at a minimum. A user with Write permission would not commit changes to a flow if they were not able to import it initially. A user with Delete permission would not delete a flow if they could not view it. -3. Enter or select a username. +NOTE: If a user has a bucket policy and the group that the user is in also has a policy, all policies are used to determine access. For example, assume User1 is in Group1, User1 has READ privileges on Bucket1 and Group1 has READ privileges on Bucket2. In this scenario, User1 will have READ privileges on both Bucket1 and Bucket2. -<SCREENSHOT> +===== Create a Bucket Policy +1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row of the bucket. -4. Select the checkbox next to the desired permission for the user: +2. Select the "New Policy" button. -* All - The selected user is able to view, add and delete flows in the bucket. +image::new_bucket_policy_create.png["Create New Bucket Policy"] -* Read - The selected user is able to view flows in the bucket. +[start=3] +3. Select a user, check the desired permissions and select the "Apply" button: -* Write - The selected user is able to view and add flows in the bucket. +image::new_bucket_policy_user_permission.png["New Bucket Policy User and Permissions"] -* Delete - The selected user is able to view and delete flows in the bucket. +[start=4] +4. The policy is added to the bucket: -===== Delete a Bucket Policy -1. Select the Edit button (pencil icon) in the row of the bucket. +image::new_bucket_policy_added.png["New Bucket Policy Added"] -<SCREENSHOT> +===== Delete a Bucket Policy +1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row of the bucket. -2. Select the Delete button (trash icon) in the row of the policy. +2. Select the Delete button (image:iconDelete.png["Delete Icon"]) in the row of the policy. -<SCREENSHOT> +image::delete_bucket_policy.png["Delete Policy"] +[start=3] 3. From the Delete Policy dialog, select "Delete". -<SCREENSHOT> +image::delete_bucket_policy_dialog.png["Delete Policy Dialog"] -Manage Users -------------- +Manage Users & Groups +--------------------- +To manage users/groups, enter the Administration section of the Registry by clicking the Settings button (image:iconSettings.png["Settings Icon"]) on the top right of the UI. Select Users from the top menu to open the Users window. -==== Add a User -1. Enter the Administration section of the Registry by clicking the Administration button (wrench icon) on the top right of the UI. +==== Sorting & Filtering Users/Groups +Users/groups can be sorted alphabetically by Name (ascending or descending) using the up/down arrows. -<SCREENSHOT> +image::users_sort_by_name.png["Users Sort By Name"] -2. Select Users from the top menu to open the Users window. +The Users/groups listed can be filtered by: -<SCREENSHOT> +* user name +* user ID +* group name +* group ID -2. Select the "Add User" button. Enter the desired username or 'Identity' information relevant to the authentication method chosen to secure your NiFi Registry instance. Select the "Add" button. +Here is an example of filtering by user name: -<SCREENSHOT> +image::users_filter_by_name.png["Users Filter By Name"] -NOTE: To quickly create multiple users, check the "Keep this dialog open after adding user" checkbox. +==== Add a User +1. Select the "Add User" button. -==== Edit a Username -1. Select the Edit button (pencil icon) in the row of the user. +image::add_user_button.png["Add User"] -<SCREENSHOT> +[start=2] +2. Enter the desired username or appropriate Identity information. Select the "Add" button. -2. Enter a new username for the user and select the "Save" button. +image::add_user_dialog.png["New User Dialog"] -<SCREENSHOT> +NOTE: To quickly create multiple users, check "Keep this dialog open after adding user". ==== Delete a User -1. Select the Delete button (trash icon) in the row of the user. +1. Select the Delete button (image:iconDelete.png["Delete Icon"]) in the row of the user. -<SCREENSHOT> +image::delete_user_single.png["Delete Single User"] +[start=2] 2. From the Delete User dialog, select "Delete". -<SCREENSHOT> +image::delete_user_dialog.png["Delete User Dialog"] ==== Delete Multiple Users 1. Select the checkboxes in the rows of the desired users to delete. -<SCREENSHOT> - -2. Select the "Actions" drop-down and click the "Delete selected users" option. - -<SCREENSHOT> +image::check_multiple_users.png["Check Multiple Users"] -==== Grant Administrator Privileges -Users with administrator privileges can add, edit and delete users, groups, buckets and policies. +[start=2] +2. Select the "Actions" drop-down and click the "Delete" option. -1. Select the Edit button (pencil icon) in the row of the user. +image::delete_multiple_users.png["Delete Multiple Users"] -<SCREENSHOT> +[start=3] +3. From the Delete Users dialog, select "Delete". -2. Check the "Grant this user administrator permissions" checkbox +image::delete_users_groups_dialog.png["Delete Users Dialog"] -<SCREENSHOT> -Manage Groups -------------- +==== Edit a User Name +1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row of the user. -==== Add a Group -1. Enter the Administration section of the Registry by clicking the Administration button (wrench icon) on the top right of the UI. +image::manage_user.png["Manage User"] -<SCREENSHOT> +[start=2] +2. Enter a new user name and select the "Save" button. -2. Select Users from the top menu to open the Users window. +image::user_nav_name_edit.png["Edit User Name"] -<SCREENSHOT> +WARNING: Some users cannot have their names edited. For example, those defined by LDAP. These users will be specially highlighted in the list. -3. Select the "Actions" drop-down and click the "Create new group" option. +image::users_non_configurable.png["Non-configurable Users"] -<SCREENSHOT> +==== Special Privileges +Special privileges are additional permissions that allow a user to manage or access certain aspects of the Registry. The special privileges are: -4. Enter a name for the Group and select the "Create" button. +* *Can manage buckets* - Allow a user to manage all buckets in the registry, as well as provide the user access to all buckets from a connected system (e.g., NiFi). -<SCREENSHOT> +* *Can manage users* - Allow a user to manage all registry users and groups. -NOTE: To quickly create multiple groups, check the "Keep this dialog open after creating user" checkbox. +* *Can manage policies* - Allow a user to grant all registry users read, write, and delete permission to a bucket. -==== Edit a Group -1. Select the Edit button (pencil icon) in the row of the group. +* *Can proxy user requests* - Allow a connected system (e.g., NiFi) to process requests of authorized users of that system. -<SCREENSHOT> +===== Grant Special Privileges to a User +1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row of the user. -2. Enter a new username for the group and select the "Save" button. +image::manage_user.png["Manage User"] -<SCREENSHOT> +[start=2] +2. Check the desired privileges: -==== Delete a Group -1. Select the Delete button (trash icon) in the row of the group. +image::user_special_privileges.png["User Special Privileges"] -<SCREENSHOT> +[start=3] +3. Changes made to special privileges are automatically saved. -2. From the Delete Group dialog, select "Delete". +Manage Groups +------------- -<SCREENSHOT> +==== Add an Empty Group +1. With no users checked, select the "Actions" drop-down and click the "Create new group" option. -==== Delete Multiple Groups -1. Select the checkboxes in the rows of the desired groups to delete. +image::create_new_group.png["Create New Group"] -<SCREENSHOT> +[start=2] +2. Enter a name for the Group and select the "Create" button. -2. Select the "Actions" drop-down and click the "Delete selected groups" option. +image::create_new_group_dialog.png["Create New Group Dialog"] -<SCREENSHOT> +NOTE: To quickly create multiple empty groups, check the "Keep this dialog open after creating user" checkbox. -==== Add Users to a Group -1. Select the Edit button (pencil icon) in the row of the user. The Membership tab is selected by default. -<SCREENSHOT> +==== Add User to a Group +1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row of the user. 2. Select the "Add To Group" button. -<SCREENSHOT> - -3. In the "Add to Group" dialog, select the group(s) to add the user to. Select the "Add" button when all desired groups have been selected. - -<SCREENSHOT> - -==== Add Multiple Users to a Group -1. Select the checkboxes in the rows of the desired users. - -<SCREENSHOT> - -2. Select the "Actions" drop-down and click the "Add selected to group" option. +image::user_nav_add_to_group.png["Add User to Group"] -<SCREENSHOT> +[start=3] +3. In the "Add User to Groups" dialog, select the group(s) to add the user to. Select the "Add" button when all desired groups have been selected. -==== Remove a User from a Group - -===== User Window -1. Select the Edit button (pencil icon) in the row of the user. The Membership tab is selected by default. - -<SCREENSHOT> - -2. Select the remove button (remove icon) in the row of the group. - -<SCREENSHOT> +image::add_user_to_groups_dialog.png["Add User to Groups Dialog"] -===== Group Window -1. Select the Edit button (pencil icon) in the row of the group. The Members tab is selected by default. - -<SCREENSHOT> +[start=4] +4. The user is added to the group: -2. Select the remove button (remove icon) in the row of the desired user(s). +image::group_added.png["Group Added"] -<SCREENSHOT> +NOTE: Groups cannot contain other groups. -==== Add a Policy -1. Select the Edit button (pencil icon) in the row of the group. Select the "Policies" tab. +==== Create a New Group with Selected Users +1. Select the checkboxes in the rows of the desired users. From the "Actions" drop-down, click the "Create new group" option. -<SCREENSHOT> +image::select_users_create_new_group.png["Select Users for New Group"] -2. Select the "New Policy" button. +[start=2] +2. Enter a name for the Group and select the "Create" button. -<SCREENSHOT> +image::select_users_create_new_group_dialog.png["Create New Group Dialog"] -3. Enter or select a bucket. +[start=3] +3. The new group is created with the selected users as members: -<SCREENSHOT> +image::select_users_new_group_added.png["New Group Added with Selected Users"] -4. Select the checkbox next to the desired permission for the group: +==== Remove a User from a Group +There are two ways to remove a user from a group. -* All - The users in the group are able to view, add and delete flows in the bucket. +===== User Window +1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row of the user. -* Read - The users in the group are able to view flows in the bucket. +2. In the Membership section of the window, select the Remove button (image:iconDelete.png["Delete Icon"]) in the row of the group. -* Write - The users in the group are able to view and add flows in the bucket. +image::remove_group_from_user.png["Remove Group From User"] -* Delete - The users in the group are able to view and delete flows in the bucket. +===== Group Window +1. Select the Manage button (image:iconManage.png["Manage Icon"]) in the row of the group. The Members tab is selected by default. -==== Delete a Policy -1. Select the Edit button (pencil icon) in the row of the group. Select the "Policies" tab. +2. In the Membership section of the window, select the Remove button (image:iconDelete.png["Delete Icon"]) in the row of the user. -<SCREENSHOT> +image::remove_user_from_group.png["Remove User From Group"] -2. Select the Delete button (trash icon) in the row of the desired policy to delete. +==== Other Group Level Actions -<SCREENSHOT> +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.
