Loading...
Loading...
Loading...
Loading...
Loading...
The TigerGraph Admin Portal is a browser-based devops tool which provides users an overview of a running TigerGraph system, from an application and infrastructure point of view. It also allows the users to configure the TigerGraph system through a user-friendly interface. This guide serves as an introduction and quick-start manual for Admin Portal.
As of Jan 2020, the Admin Portal is certified on following browsers:
Not all features are guaranteed to work on other browsers.
Please make sure to enable JavaScript and cookies in your browser settings.
The Admin Portal and GraphStudio share the same port (14240). If you are logged in one of the servers for your TigerGraph system, you can use localhost
for your <tigergraph_server_ip_address>. The Admin Portal is on the admin page:
If user authentication has been enabled, users need to log in to access the Admin Portal.
The Admin Portal v3.1 has three main parts: Dashboard, Monitor and Management. All the pages share the same Header, Footer, and Navigation Menu.
The layout of the Admin Portal is responsive to screen size. The layout will automatically adjust for devices with small screens like phones and tablets.
The full screen version of the Admin Portal is shown below, with the Dashboard page selected.
The mobile version is shown below:
To view the full text, you can click on a notification to open a popup window containing the full message and its severity:
There are three severity levels: info, warning and error.
You can switch between a dark theme and light theme. The light theme is shown below:
To sign out of the Admin Portal, click on the Sign out button in the Account menu.
Clicking on the Help button will take you to the documentation page containing this guide.
Green indicates all services are online.
Gray means one or more service statuses is unknown.
Red means on of the component services is offline.
Clicking on the button will show you the status for the services in our system:
Admin Portal has a default session timeout of 1 week. If, during this time, the user has no interaction with the page, the session will expire and the user will be logged out automatically. The timeout can be configured with:
If you are already at GraphStudio, simply click the Admin button at the right end of the top menu bar.
Clicking on the Notification iconwill open up a list of notifications. If a notification is too long, some of its content will be omitted:
The Account iconwill open the user menu:
You can navigate to GraphStudio by clicking on.
The overall system statusis always shown in the footer. This single indicator shows:
You can start or stop services from the Admin Portal by using the right most buttons(NOTE: ONLY a superuser can see these buttons).
Clicking on the Stop iconwill stop GPE, GST and RESTPP services in the TigerGraph system.
Clicking on the Start iconwill start GPE, GST and RESTPP services of the services in the TigerGraph system (NOTE: because there is an interval between data collection period, the real status of the system will not be reflected in the status section right away).
Browser
Chrome
Safari
Firefox
Opera
Edge
Internet Explorer
Supported version
54.0+
11.1+
59.0+
52.0+
80.0+
10+
You can go to License page to update TigerGraph license key. If no TigerGraph license key is provided during TigerGraph installation time, the license page will look like this:
Click the SELECT FILE button and choose the license text file, then click UPDATE button. The license detail will be loaded like below:
You can click more details to show more information about the license:
The Dashboard page has three main parts: Overall Statistics, the Time Range Picker, and several Charts.
Just below the page header, there are four cards showing statistics of your system, including the number of nodes and the number of graphs. These statistics are refreshed live. (The default refresh interval is 1 minute).
"Now" means that the charts will be continually updated with the most recent data.
"Custom" lets you select a fixed date. The time range is historical, so the charts will be static.
The sliding bar on the right lets you fine tune the range. Click and drag an endpoint to adjust the start or end time.
Changing any of these selections will trigger a request for statistics data and the chart will be re-rendered accordingly.
Each chart displays some statistic or state information on the vertical axis and time on the horizontal axis.
There are two chart sections. The first section is GSQL Query Performance. This lists all of the queries accessible to the current user. If you click on a query name, the display will expand to show detailed charts about that query. You can expand only one query panel at a time. The second section is Cluster Monitoring. This lists all of the machines within the TigerGraph cluster. Similar to the first section, you can only expand one panel at a time.
A Query Monitoring Panel includes three charts:
QPS (number of queries completed per second)
Timeout (fraction of the query calls which timed out and therefore did not finish)
Latency (minimum, maximum, and average time to complete a query)
A Machine Monitoring Panel includes 4 charts. The first three charts break down the information among three processing-focused components (GPE, GSE, RESTPP). The last chart breaks down information among three components which may have large storage needs (GStore, Log files, and Apache Kafka).
Service status: ON or OFF status for the given component
CPU Usage: percentage of available CPU time used by the given component
Memory Usage: GB used by the given component
Disk Usage: GB used by the given component
Please note that the GraphStudio item under Applications section needs to be lightened like above. If it looks like the grayed icon here: , it means GraphStudio is not enabled in the provided license, and you won't be able to use GraphStudio in this case. You can upgrade your license to enable GraphStudio access, please contact sales@tigergraph.com for more information.
The next card lets you set the time range to be used for the statistics in the charts below. The leftmost inputlets you select the start time of the range. The next inputlets you select the end time of the range. This input has two options:
The User Management page has three tabs: My Profile, All Users and Role Management.
All users can access the My Profile tab to mange themselves.
Below the cards are secret management section. You can create as many secrets for each graph as you want, but remember to copy the secret value out at the creation time. Once you refresh the page or go to another page and come back, the actual secret value will be masked for security. You need to provide an alias for the secret, and click the green plus sign to add the secret.
When token authentication is enabled, you need to use the secrets to request tokens and add the tokens in the HTTP request headers to call TigerGraph RESTful endpoints. Read more at: User Privileges and Authentication.
Due to the difference in users' information display compared to GSQL, Admin Portal doesn't allow users with admin role to a graph to create/edit/delete users or assign a user with a role to a graph. Superuser can manage users in this case. Users with Admin role to a local graph can revoke roles to other users for this local graph.
Both native users and proxy users are displayed in the User section. However, you can only change password for native users.
Only superuser can access this tab. Superuser can add new users, change other users' password, delete users, create proxy groups, change proxy rules of the groups, and delete proxy groups.
Read more about proxy group at User Privileges and Authentication.
Admin Portal does not indicate whether a user belongs a proxy group. You can find out more from GSQL client.
Admin Portal shows a combination of roles for proxy users. Proxy user which belongs to a proxy group inherits all the roles from the proxy group plus all the roles the proxy user has. Therefore, if you want to revoke a role from a proxy user, you need to revoke the role from the proxy group first. Then you might need to revoke the same role from the proxy user if the proxy user also has that role.
Superusers and Admin users can access this tab to assign different roles to users on different graphs. Superusers can assign superuser role to other users, while admin users cannot.
You can use the dropdown menu at the top left corner to select on which graph you want to assign different roles to different users:
You can type in text to search for users:
You can sort the users by alphabetic order or number of roles they have:
You can choose to show all users, show the users who have role(s), or show the users who don't have a role:
You have two ways to grant a new role to a user.
The first way is drag-and-drop. You can drag a user from the right section to under the role you want to grant.
After the role is granted successfully, the user's name will appear under the corresponding role, and the role's color will appear on the user at the right section. You can grant multiple roles to the same user, and multiple colors will show on the user at the right section to indicate these roles.
The second way is right click a user, and choose the role you want to grant:
You have two ways to revoke a role from a user.
The first way is drag-and-drop. You can drag a user from the role you want to revoke to the right section:
After the role is revoked successfully, the user's name will disappear under the corresponding role, and the role's color will disappear from the user at the right section.
The second way is right click a user, and choose the role you want to revoke:
You can drag a user from under one role to under another role at the left section. This is a shortcut to change the user's role:
Tip: If you manage users through GSQL, please click on refresh button on the top right corner to reflect the changes in Admin Portal.
There are three information cards at the top: Username shows the user's username; Accessible graph shows how many graphs the user can access, and Password allows user to change password by clicking the key icon:
Clickto add new users:
Clickto change other users' password:
Clickto delete a user.
Clickto see all proxy groups:
Clickto add new proxy groups:
Clickto edit the proxy rule of an existing proxy group:
Clickto delete a proxy group.
Similarly, you can also clickto switch to proxy groups and manage their roles.
Due to the difference in users' information display compared to GSQL, Admin Portal doesn't allow users with admin role to a graph to create/edit/delete users or assign a user with a role to a graph. Superuser can manage users in this case. Users with Admin role to a local graph can revoke roles to other users for this local graph.
Admin Portal shows a combination of roles for proxy users. Proxy user which belongs to a proxy group inherits all the roles from the proxy group plus all the roles the proxy user has. Therefore, if you want to revoke a role from a proxy user, you need to revoke the role from the proxy group first. Then you might need to revoke the same role from the proxy user if the proxy user also has that role.
If you find any bugs, please report them to support@tigergraph.com. We really appreciate it!