This is an automated email from the ASF dual-hosted git repository.
eroma pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/airavata-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 3854f64 Adding user group details
3854f64 is described below
commit 3854f64235a40333584747e219f55b1691dddd1b
Author: Eroma Abeysinghe <[email protected]>
AuthorDate: Sun Jul 28 09:28:38 2019 -0400
Adding user group details
---
docs/user-documentation/airavata-user-profiles.md | 69 +++++++++++++----------
1 file changed, 39 insertions(+), 30 deletions(-)
diff --git a/docs/user-documentation/airavata-user-profiles.md
b/docs/user-documentation/airavata-user-profiles.md
index 1d27bcf..4c96814 100644
--- a/docs/user-documentation/airavata-user-profiles.md
+++ b/docs/user-documentation/airavata-user-profiles.md
@@ -1,47 +1,56 @@
-## Apache Airavata User Profiles
+## Apache Airavata User Groups
-### What Are Airavata User Roles?
+### What Are Airavata User Groups?
-1. Prior to using Airavata, lets identify and understand the user roles
available and their features.
-2. Knowing the roles and the features of each, will assist on shaping your
gateway user hierarchy.
-3. There are 4 active user roles in Airavata with different set of features at
each level.
+1. Prior to using Airavata, lets identify and understand the user groups
available and their features.
+2. Knowing the groups and the features of each, will assist on shaping your
gateway user hierarchy.
+3. There are 3 base user groups in Airavata with different set of features at
each level.
- Admin
- Admin-Read-Only
- Gateway-User
- - User-Pending
-### Features of each User Role
+### Features of each User Group
-1. Admin User
- - Set up gateway preferences for Compute Resources and Storage Resources
- - Generate SSH keys and their tokens using Credential Store in Admin
Dashboard.
- - Add the generated SSH token to Gateway Preferences.
+1. Admin Group
+ - Set up gateway Group Resource Profiles.
+ - Add gateway storage resource profile.
+ - Generate SSH keys for compute and storage resource SSH
communications..
+ - Add the generated SSH key to group resource profiles.
- Add the generated SSH keys to authorized_key files in each resource.
- - Can Cancel, clone experiments of a gateway user through Admin
dashboard behalf of the user.
- Create Applications and their deployments in to the gateway.
+ - Manage users, add the mto base groups.
<br><b>NOTE: If user hosts his own gateway; 'Gateway Admin' role will have
access to create compute resources and storage resources as well.</b></br><br>
-
2. Admin-Read-Only
- - Can view everything in Admin Dashboard but cannot Add, Edit or Delete
any records from dashboard.
- - Can monitor experiments through Experiments Statistics in Admin
dashboard.
- - Behalf of a gateway user can edit, cancel or clone an experiment.
+ - Can view everything in Settings but cannot Add, Edit or Delete any
records from dashboard.
+ - Can monitor experiments through Experiments Statistics in Experiment
statistics.
<br></br>
3. Gateway User
- Create, launch their own experiments in using available applications
and compute resources.
- Monitor progress of experiment execution.
- - Download outputs experiment outputs from experiment summary or from
ARCHIVE directory in Storage (ARCHIVE folder exists only if the application
files are 'Archive' enabled)
+ - Download experiment outputs from experiment summary or from the
storage.
+ - Upload files in to the storage for future use.
- Group experiments by creating Projects.
- - Request new features, applications and report bug, issue using
'Contact Us' in gateway.
+ - Create own SSH keys from Credential store
+ - Create Group Resource profiles to use individual HPC allocations for
job submission through the gateway.
- Password reset.
-<br>
-</br>
-4. User-Pending
- - This is the initial role assigned to users when account is created.
- - Until gateway admin provide relevant access to the gateway (by
assigning an active gateway role) user has cannot really use the gateway.
-<br>
-</br>
-### How User Roles Work?
-
-1. Users can have one or many user roles assigned to them.
-2. Gateway admin has the authority to change user roles of the gateway users.
-2. Every time a role changes user will be notified through email about the
privilege change.
\ No newline at end of file
+
+
+### How User Groups Work?
+
+1. Users can belong to one or many user groups.
+2. Two main categories of groups
+ - Base groups - Created as default groups in the gateway at gateway
deployment
+ - User groups - Any user in the gateway can create user groups, and add
other gateway users to the group.
+3. Users in group will have one of the three roles. Three roles are:
+ - Owner - Person who creates the user group
+ - Admin - Person who can add other users in to the group. These users'
role cannot be changed by users with admin role.
+ - Member - This person can use benefits of the group, but cannot add or
remove users from the group.
+4. Only the owner of the group can change users; role.
+5. Adding users to base groups can be done using two interfaces.
+ - Settings → Manage Users
+ - Top right-hand corner dropdown menu → Groups
+6. Adding users to any other group that you are an admin of or the owner of
can be done using
+ - Top right-hand corner dropdown menu → Groups
+7. In Manage Users page, users are listed with all the groups they are a
member of.
+
+
