Skip to main content
Version: 2.12.0 🚧

User Role Guide

Introduction​

Welcome to the User Role Guide! This guide is essential for managing user permissions and access within Superna Eyeglass. Below, you can find the information regarding requirements, quick start steps, adding groups, and logging in with RBAC(Role Based Access Controls) in Superna Eyeglass. Use the navigation below to explore each section of the guide.

Requirements​

info

Before setting up user roles in Superna Eyeglass, ensure the necessary prerequisites are met.

  • Confirm Permissions:

    • Administrative rights are required to set up and manage user roles.
    • Ensure that the account used for setup has full admin privileges in Eyeglass. User Management Admin Privileges
    Administrator Access

    ADMIN_STORAGE_QUOTA_REQUESTS: Search and display quotas, bulk limit quota update.

    AIRGAP: View and modify AirGap jobs configuration.

    ANYC_ADMIN: View anycopy jobs for all users. Can create, edit, and run anycopy jobs.

    ALARMS: View and clear alarms.

    APP_REGISTER: Register appliance on the cloud dashboard.

    BACKUP: Create and view backups of the Eyeglass appliance.

    CLUSTER_REPORTS: Create cluster, RPO, and CSM reports and view cluster reports.

    CLUSTER_STORAGE: View the cluster storage dashboard.

    DATA_CONFIG_MIGRATION: View the data config migration dashboard.

    DR_READINESS: View the DR Readiness of the managed devices.

    EASY_AUDITOR_MODIFY: Add and update reports, queries, schedules, and wiretaps.

    FAILOVER_HISTORY: View previous failovers.

    FILE_LOCK_PORTAL: Remove lock from locked files.

    INVENTORY_MODIFY: Add new managed devices or delete existing managed devices.

    JOBS_MODIFY: Start and modify Eyeglass jobs.

    LAUNCH_FAILOVER: Initiate Access Zone, SyncIQ, or DFS failovers.

    LICENSES: View, add, and remove Eyeglass licenses.

    LOGS: View Eyeglass logs.

    LOG_PARSER: Parse user backups.

    NOTIFICATIONS: Configure email, Twitter, Slack notifications.

    PHONEHOME: Modify phone home settings and run phone home jobs.

    RANSOMWARE_DEFENDER: View and configure Ransomware Defender.

    REMOTE_SERVICES: View and update remote Eyeglass services (probes).

    REST_API: Add or delete REST API tokens and define new widgets.

    USER_ROLES: Manage user roles and authentication.

    PERFORMANCE_AUDITOR: View Performance Auditor window.

  • Active Directory (AD) Authentication Provider:

    • The PowerScale OneFS's system zone must have an AD authentication provider added to validate passwords and retrieve AD group membership from AD.

  • Verify PowerScale OneFS's Active Directory Integration:

    • Ensure Active Directory (AD) is properly configured and accessible.

  • PowerScale OneFS's SMB Protocol Configuration:

    • Ensure that port 445 for the SMB protocol is open between the Eyeglass VM and the cluster.
    • SMB protocol must be enabled in the system zone.
    • SMB2 protocol is required for AD authentication of users with an SMB share in the system zone.

  • Trusted Domains:

    • Trusted domains can be used when adding users or groups. The trusted domain must trust the AD domain added to the system zone.

  • System Zone Authentication:

    • System Zone authentication is the only supported proxy login method and requires an AD provider in the system zone.
    • The login process will attempt to validate passwords on all clusters added to Eyeglass using SMB and system zone authentication requests over SMB.

Setup Steps​

info

A quick guide to setting up user roles in the environment

  1. Create Roles: Use predefined roles or create new ones based on specific requirements.
  2. Assign Permissions: Assign appropriate permissions to the roles.
  3. Assign Roles to Users: Map AD groups or individual users to the roles created.

Detailed Steps​

Create Roles​

  1. Go to the user roles section. User roles button
  2. Choose 'Create New Role'. Create a new role button
  3. Define the role’s name. Define the role's name

Assign Permissions​

  1. Select the created role.
  2. Assign necessary permissions (e.g., read, write, admin). Define role permissions

Assign Roles to Users/Groups​

  1. Access User Roles: User roles button
  2. Select Role: In the Roles tab, select the role to assign to the user. eyeglass_user_roles_screen
  3. Add User or Group: Go to the Users or Groups tab and click the plus sign (+) to add a user to the selected role. eyeglass_user_roles_screen
  4. Enter User Details: Input the username of the user and specify whether they are a remote user or a local user.
  5. Click Add: Confirm the addition by clicking Add. eyeglass_user_roles_screen
  6. Verify Permissions: Test the role assignments by logging in as a test user to ensure they have the correct permissions.

AD Group Based User Roles​

info

Set up RBAC quickly using AD groups with this method.

  1. Access User Roles Section: Navigate to the User Roles section in Eyeglass.
  2. Select a Role: Choose the role you want to assign AD groups to from the list of roles.
  3. Add Groups: If the groups are not listed, use the "+" button to add the AD groups.

Detailed Steps​

  1. Access User Roles Section:

    • Navigate to the "User Roles" section in the Eyeglass interface. User Roles section

  2. Select a Role

    • From the list of roles on the left, select the role you want to work with. role selection interface

  3. Add Groups

    • If the groups associated with the role are not listed, click the "+" button in the "Groups" section to add a new AD group.
    • Enter the group name and confirm. add a group using the "+" button

Logging in with User Roles​

info

Here’s how to log in using user roles accounts for enhanced security.

  1. Navigate to Login Page Go to the Eyeglass login page.
  2. Enter Credentials: Use your AD credentials mapped to an Eyeglass role.
  3. Access Dashboard: Upon successful login, you will have access to resources based on your assigned role.

Detailed Steps​

  1. Navigate to Login Page
    • Open your browser and go to the Eyeglass login page. Eyeglass Login Page