Django Portal for Airavata: Gateway Admin Guide

Account Creation & Login

1. From the gateway home page, users can access ‘Create Account’ and ‘Log In’.
2. Users can use their existing institute credentials (through CILogon) to get authorization to the gateway or create a local gateway account.
3. Once the account is created or an existing account is used, the user needs to be added to an existing base group; Admin Users group, Read-Only Admin Users group or the most common for general users is Gateway User group.
4. Gateway admin or a group user with 'Admin' role, can add the user to one of the groups using ‘Groups’ space from the top menu.

User Groups

1. 'Groups' page is to manage users within groups and to create new user groups.
2. All gateway users have access to this page but you would only be able to edit 
   1. Groups where you are the owner
   2. Groups where you are a member with Admin role
3. Using the ‘Groups’ menu the gateway admin can manage access to application tools and compute resources and their properties.
4. In order to view existing groups and to edit them, navigate to ‘Groups’ from the top-right menu.
5. Gateway admins and gateway users can create groups. Anyone who creates a group can add other users to the group and give them the role of ‘Member’ or ‘Admin’.
6. A user who has the role ‘Admin’ in a group can add new users to the group and change the roles of the existing users. 
7. Removing users from the group can only be done by the group ‘Owner’.
8. There are three roles within a group; Owner, Admin, and Member.

Base Groups

1. Utility groups are created by default with the gateway deployment. They would primarily decide the level of access a user has to different levels (Workspace, Admin, Groups) of the gateway.
2. The gateway admin will have access to these groups and can add new users, remove them or change roles within the group.
3. General gateway users would be in Gateway User Group.

Adding Group Users

1. In order to add users to a group you need to be
1. Owner of the group OR
2. Have an admin role in the group
2. In Group space click ‘Edit’ in the group, you want to add, change role, or delete a user from.
3. Search for the user by typing in the name in the search area and select and add.
4. Once the user has been added you can change their role or leave it with the default role and ‘Submit’.
5. The same interface is used to change existing user roles and to delete existing users from the group. NOTE: Deleting users can only be done by the Owner of the group. Changing the role and adding new users can be done by both Owner and Admin users of the group.

Settings

1. Admin space of the gateway is used to carry out gateway admin user responsibilities.
2. Users who are in the Admin group can work in the Admin space.
3. NOTE: Any user can view the Admin space content but editing and other actions are restricted to gateway admin group users.
4. The Admin space consists of
1. Application Catalog
2. Manage Users
3. Credential Store
4. Group Resource Profile
5. Gateway Resource Profile
6. Notifications

Group Resource Profile

1. Group Resource Profile is where you would create a profile for a group or groups of users to configure the compute resource properties; limits on walltime, queues and queue limits.
2. In ‘Group Resource Profile’ you can view existing profiles, edit them and delete them.
3. To create new profiles, use ‘New Group Resource Profile’ button.
4. To create the new profile provide
1. Name
2. Default SSH Credential
3. New Compute Preference 
5. When adding a credential, you could use an existing one from the list or create one using the + sign.
6. To add a new compute resource, select the compute resource from the list and then provide access details including login name, a specific credential for this resource if needed, if not it will use the group resource profiles credential. Then edit the ‘Policy’ as needed. Policy is the definition of which queues are available and their properties for the profile. After entering this information use the Save option.
7. A group resource profile can have more than one compute resource preferences.
8. In group resource profile, using ‘Share’ button you can add user groups and users to this profile.
9. Users or groups added to use this profile will be listed under ‘Currently Shared with’.
10. When adding ‘shared with’ information, WRITE permission means that the users can use this particular profile at the time of experiment creation and also the user has the permission to edit the group resource profile. The read only permission will only allow the user to use the profile at the experiment creation.

Application Catalog

1. Application tools are configured in Application Catalog. Application tools are application codes that gateway users execute to run their computations.
2. In Application catalog you can:
1. View existing applications
2. Edit existing applications
3. Delete an application
4. Create a new application
3. In order to edit an application click on the application tile.
4. To delete an application, click on the application tile, and in ‘Details’ tab select ‘Delete’. Select ‘Confirm’ in the pop-up message.

Add a New Application

1. Click ‘New Application +’ in the Application Catalog
2. Add application information in the ‘Details’ tab and Save.
3. Then in the ‘Interface’ tab add the application inputs and outputs.
1. Standard-Error and Standard-out is available by default in the Interface. If you need to add option buttons as input, please follow; Instructions to adding option buttons 
2. If you need to add cascading input values for users to select and add please refer to Cascading input instructions 
4. In ‘Deployments’ tab click the ‘New Deployment’ button.
5. Select the application residing/deployed compute resource
1. NOTE: If the compute resource you are looking for is not in the list, its missing from group resource profile. First, go to group resource profile and add the compute resource. 
6. Select a compute resource from the listed and add the deployment details and provide a default queue.
7. In the compute resource there is a ‘Share’ option.
1. This particular sharing will restrict running the application in a particular resource by the shared users and groups only.
2. E.g: If its IU resource, you could add a group which has only IU users.
3. This will restrict access to users in different machines.
4. You could use this same option to restrict license software users as well. Only share deployments with users who you want to give access to in a particular resource. E.g.: In Comet, Gaussian can only be used by 25 users. Make sure you have a group with the required number of users you share with.
8. An application can have multiple deployments.