Unified SaaS Login
There is a unified SaaS login (or a single sign-on) from where you can get access to all the clusters. You just need to click the cluster name for which you need to view the data as per your requirements without login in repeatedly for multiple clusters.
- SAAS controller module accepts connections from the agents.
- This module accepts, authenticates, and sends Master NDE controller information to the agent.
- Once the agent is authenticated and receives the controller information, it connects to the Master NDE controller.
- Master NDE controller can redirect the agent connection to any of the NDE servers in the cluster (existing routing of agent connection based in Tier)
- Once the Agent connection is made with Cluster NDE, server-monitoring starts.
- End-user can connect to the SAAS controller after authentication. The end-user can see the projects for which he is authorized.
- Project Key Management UI: This includes the Account and Project listing page, Account and Project creation option, and project key creation.
- SaaS Build Info tab: The details include, machine/environment DNS name or IP, current build version, and date/time at which that environment was upgraded.
- SaaS Account and Project Operations: The operations include, Activate/Deactivate account or project, delete a project.
- SaaS Enterprise Admin group and capability: To display the Enterprise Capability for enterprise login with various permissions.
- Only respective account and project in the project management page
- Only respective project cluster available on enterprise home page
- Able to view left side menu
- SaaS License UI: It is introduced to take values for a set of predefined fields and generate the license.
- Enable Token Authentication: To enable token authentication in authenticateUser service for authentication via a token.
Accessing the SaaS UI
Follow the below-mentioned steps to access the SaaS UI:
- Enter the SaaS URL in the browser and hit ENTER.
2. Enter the User Name and click NEXT. It is mandatory to provide the domain name in the user name.
3. Enter the password and click Login.
4. This displays the Enterprise Home window where you can see the environment list and build information. The detailed description is provided in the subsequent sections.
This window is further categorized into the following tabs – Environment List and Build Information.
This window displays a list of environments (project clusters) with environment name and environment IP.
- The environments marked with Red color denote the inactive environments and are not clickable.
- The environments marked with Black color denote the active environments and are clickable. You can enter into that environment by simply clicking over it.
- You can see the total project clusters at the top right corner. Example –
- You can also search for an environment from the search box.
This window displays the build information of the machines, which are assigned to any account in SaaS mode.
The following details are displayed:
- Machine/Environment Name: The machine/environment DNS name or IP.
- Build Version: The current build version. If somehow there is a failure in fetching the build information of any particular node, it is displayed as ‘Build Info Not Available’.
- Upgrade Date/Time: The date/time at which that environment was upgraded in the (yyyy/mm/dd hh/mm/ss) format.
Here, you can create an account and associate projects with that account. You can also manage (such as edit, deactivate, and delete) accounts and projects from this section. Go to Advanced > Account-Project Management to access the Account-Project Management window.
This displays the Project Key Management window.
The details of each field and the operations you can perform are described in the subsequent sections.
This section displays the details of all the accounts created. The details include:
- Account Name: The name by which the account is identified.
- Account Description: The description of the account.
- SSO URL: The URL to which the SaaS machine is redirected after providing the respective username.
- Account Domain: SaaS machine checks the account based on the domain.
- Action: Actions that can be performed on an account include – Edit / Activate / Deactivate / Delete.
In this section, you can manage accounts and perform operations, such as create, edit, deactivate, delete. The details of these operations are described in the subsequent sections.
Create an Account
With the help of this window, you can add a new account to login SaaS machine. Here, you need to provide the Account Name, Account Domain, and Account Description. Out of these, the Account Domain field is an important field where you need to mention a domain (ex: cavisson.com). SaaS machine checks the account based on the domain.
- On the top-right corner of the window, go to Create New > Account.
2. This displays the Create New Account window.
3. Provide the following details and click Save.
- Account Name: Name of the account.
- Account Domain: Domain of the account.
- Account Description: Description of the account.
- SSOEnabled: This is to enable SSOEnabled login to the SaaS machine. SSOEnabled is used such that user can be redirected to the respective SSO (Example: OKTA, PingID, OpenAM). If SSO is enabled, it is redirected to the respective SSO after providing the Username on the SaaS login page.
- SSO URL: The URL to which the SaaS machine is redirected to after providing the respective username.
- SSO Key: To provide the Entity ID for that respective SSO. For SP mode, provide saml.properties and for IDP mode, provide sso.xml.
Note: The respective SSO should be configured properly, such as the SSO URL, SSO Key, and Get Entity Id.
- This creates the account and is added to the account table.
Edit an Account
- Click the icon corresponding to an account for which you need to edit the details.
2. This displays the Edit Account window.
3. Edit the details as required and click Save.
Deactivate an Account
You can deactivate an account as per requirements. To do so, click the icon corresponding to an account, which needs to be deactivated.
Delete an Account
You can delete an account with the icon. Before deleting an account, you need to delete all its associated projects.
This section displays the details of all the projects created. The details include:
- Project Name: Name of the project.
- Project Key: Unique key associated with the project.
- Project Type: Type of the project, either ‘Trial’ or ‘Licensed’.
- License ID: Licensed ID of the project if the project is of ‘Licensed’ type.
- Action: Actions that can be performed on a project include – Edit / Generate License / Activate / Deactivate / Delete.
In this section, you can manage projects and perform operations, such as create, edit, generate a license, deactivate, and delete. The details of these operations are described in the subsequent sections.
Create a Project
- On the top-right corner of the window, go to Create New > Project.
2. This displays the Create New Project window.
3. Provide the following details and click Save.
- Account Name
- Project Name
- Project Description
- Project Type
4. This creates the project within the specified account and is added to the Project table. You can add multiple projects within an account in the same manner.
Edit a Project
- Click the icon corresponding to a project for which you need to edit the details.
2. This displays the Edit Project window.
3. Edit the details as required and click Save.
Deactivate/Activate a Project
You can deactivate a project as per requirements. To do so, click the icon corresponding to a project, which needs to be deactivated. To activate it, click the icon.
Delete a Project
The following points are to be noted before deleting any account:
- A project is dependent on an account and a project cluster is dependent on a project. Therefore, for deleting a project, you also need to consider the project cluster.
- You cannot delete a project cluster. In addition, a project cluster has many to many relationships with an ACL Group. Therefore, when deleting a project, first you need to delete the project clusters related to it. It goes for the relationship between an account and a project.
You can generate license for your projects by using the icon. This displays a license form and you need to fill it.
Provide the following details:
- Validity Start Date
- Validity End Date
- License Type
- Number of Agents
- Number of Database Servers
- Number of Hosts Monitored
- Number of Browser Page Views
- Log Ingressed
- Number of Log Queries
- Disk capacity utilized For Logs(TB)
Metric Data points
- Number of Metric sent
- Number of Concurrent users
- Page views
- Number of Flowpath Number
Generate Project Key
You can generate a unique project key for a project. To do so, select a project and click the Generate Project Key button. The existing project key is overwritten with a new one.
Note: The project key starts with the project name.
Enterprise Admin Group and Capability
You can assign enterprise capability for enterprise login with permissions as follows:
- Only respective account and project in project management page
- Only respective project cluster available in enterprise home page
- Can view left side menu
Assigning Enterprise Capability to a Group
Follow the below mentioned steps for this implementation:
- Go to Admin > Access Control.
2. Go to the Groups tab and select the Enterprise Group (For example – Enterprise@cavisson.com).
3. In the Capabilities section, click the button. This displays the Add Capabilities window.
4. Select the desired capability from the list and click Attach. The added capability is displayed in the Capabilities section.
Assigning Project Cluster to a Group
- In the ACL window, go to the Groups tab and select the Enterprise Group (For example – Enterprise@cavisson.com).
2. In the Project Clusters section, click the button. This displays the Add Machine For Enterprise Environment window.
3. Select the desired machine from the list and click Attach. The added machine is displayed in the Project Clusters section.