Skip to content

Commit 6108483

Browse files
committed
chore: update doc to reflect the new UI design
1 parent e6e80d2 commit 6108483

8 files changed

+121
-36
lines changed

content/influxdb3/cloud-dedicated/reference/admin-ui.md

Lines changed: 121 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -12,89 +12,174 @@ weight: 105
1212
The Administrative (Admin) UI for {{% product-name %}} is a browser-based, no-code way to manage your {{% product-name %}} environment and perform administrative tasks, such as creating and managing clusters, databases, and tokens.
1313

1414
- [Access the Admin UI](#access-the-admin-ui)
15-
- [Account management](#account-management)
15+
- [Navigate the Admin UI](#navigate-the-admin-ui)
16+
- [Account and cluster management](#account-and-cluster-management)
1617
- [Resource management](#resource-management)
17-
- [Manage clusters](#manage-clusters)
18+
- [View cluster overview and metrics](#view-cluster-overview-and-metrics)
1819
- [Manage databases](#manage-databases)
1920
- [Manage tables](#manage-tables)
2021
- [Manage database tokens](#manage-database-tokens)
21-
- [Additional Features](#additional-features)
22-
22+
- [Manage management tokens](#manage-management-tokens)
23+
- [Manage users](#manage-users)
24+
- [Get help and support](#get-help-and-support)
2325

2426
## Access the Admin UI
2527

26-
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-login.png" alt="InfluxDB Cloud Dedicated Admin UI login page" />}}
27-
2828
Customers can access the Admin UI at [console.influxdata.com](http://console.influxdata.com) using the credentials provided by InfluxData.
2929
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
3030

31-
After you log in to the Admin UI, the Account Management portal provides an entrypoint to view your account information and manage your {{% product-name %}} resources.
31+
## Navigate the Admin UI
32+
33+
The Admin UI features a collapsible sidebar navigation that provides quick access to all administrative functions:
34+
35+
- **Overview**: View cluster details, metrics, and operational status
36+
- **Databases**: Create and manage databases
37+
- **Tables**: View and manage tables within databases
38+
- **Database Tokens**: Create and manage authentication tokens for database operations
39+
- **Management Tokens**: Create and manage tokens for account-level administrative tasks
40+
- **Users**: View and manage user access and invitations
41+
- **Help**: Access documentation, contact support, or reach sales representatives
42+
43+
## Account and cluster management
44+
45+
The Admin UI uses a hierarchical navigation system with account and cluster selection at the bottom of the sidebar:
46+
47+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-account-switcher.png" alt="InfluxDB Cloud Dedicated Admin UI account and cluster switcher" />}}
48+
49+
### Switch between accounts
3250

33-
## Account management
51+
1. Click the **Account** selector at the bottom of the sidebar
52+
2. Search for or select an account from the list
53+
3. The UI updates to show resources for the selected account
3454

35-
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png" alt="InfluxDB Cloud Dedicated Admin UI account management cluster list" />}}
55+
### Switch between clusters
3656

37-
- View account details and associated clusters
38-
- Create, view, and manage management tokens for account-level operations
39-
- Access contract information (status, start date)
57+
1. Click the **Cluster** selector at the bottom of the sidebar
58+
2. Search for or select a cluster from the list
59+
3. The UI updates to show resources for the selected cluster
4060

41-
For more information, see the following:
61+
### View all accounts
4262

63+
To view all accounts across your organization:
64+
65+
1. Click **All Accounts** from the account switcher menu
66+
2. View a list of all accounts with their IDs, status, type, and creation dates
67+
3. Use the search bar to filter accounts by name or ID
68+
69+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-all-accounts.png" alt="InfluxDB Cloud Dedicated Admin UI all accounts view" />}}
70+
71+
### View all clusters
72+
73+
To view all clusters across accounts:
74+
75+
1. Click **Overview** in the sidebar to access cluster views
76+
2. Navigate to the clusters list to see all available clusters
77+
3. View cluster IDs, status, creation dates, and size information
78+
4. Use available actions to copy cluster IDs or URLs, or observe clusters in Grafana (if enabled)
79+
80+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-all-clusters.png" alt="InfluxDB Cloud Dedicated Admin UI all clusters view" />}}
81+
82+
For more information, see:
4383
- [View account information](/influxdb3/cloud-dedicated/admin/account/)
44-
- [Manage management tokens](/influxdb3/cloud-dedicated/admin/tokens/)
84+
- [Manage clusters](/influxdb3/cloud-dedicated/admin/clusters/)
4585

4686
## Resource management
4787

48-
The Admin UI lets you manage {{% product-name %}} resources, such as databases,
49-
tables, and tokens, associated with a cluster.
88+
The Admin UI lets you manage {{% product-name %}} resources, such as databases, tables, and tokens, associated with a cluster.
5089

51-
- [Manage clusters](#manage-clusters)
52-
- [Manage databases](#manage-databases)
53-
- [Manage tables](#manage-tables)
54-
- [Manage database tokens](manage-database-tokens)
90+
### View cluster overview and metrics
5591

56-
### Manage clusters
92+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-overview.png" alt="InfluxDB Cloud Dedicated Admin UI cluster overview" />}}
5793

58-
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png" alt="InfluxDB Cloud Dedicated Admin UI cluster options" />}}
94+
The **Overview** page displays real-time cluster information and metrics:
5995

60-
- View cluster IDs, statuses, creation date, and sizing information
61-
- Access Grafana dashboards for operational monitoring (if enabled for the account)
62-
- View and manage resources (such as databases, tables, and database tokens) associated with a cluster
96+
- **Cluster Details**: View cluster name, status, creation date, cluster ID, and cluster URL
97+
- **Cluster Size**: See CPU allocation and component vCPU distribution (Ingest, Compaction, Query, System)
98+
- **Cluster Metrics**: Monitor CPU usage, memory usage, and ingest line protocol rate with time-series charts
99+
- Configure the metrics time range and enable live updates for real-time monitoring
63100

64101
For more information, see [Manage clusters](/influxdb3/cloud-dedicated/admin/clusters/).
65102

66103
### Manage databases
67104

68-
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-databases.png" alt="InfluxDB Cloud Dedicated Admin UI cluster resources databases list" />}}
105+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-databases.png" alt="InfluxDB Cloud Dedicated Admin UI databases list" />}}
106+
107+
Use the **Databases** page to manage databases within the selected cluster:
69108

70109
- Create and delete databases
110+
- View database IDs and configuration limits
71111
- Update retention periods
72112
- Configure maximum tables and columns per table
73-
- View and manage tables associated with a database
113+
- Navigate to tables associated with a database
74114

75115
For more information, see [Manage databases](/influxdb3/cloud-dedicated/admin/databases/).
76116

77117
### Manage tables
78118

79-
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-tables.png" alt="InfluxDB Cloud Dedicated Admin UI database tables list" />}}
119+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-tables.png" alt="InfluxDB Cloud Dedicated Admin UI tables list" />}}
80120

81-
- View tables associated with databases
82-
- See table IDs and sizes
121+
Use the **Tables** page to manage tables within databases:
122+
123+
- Select a database from the dropdown to view its tables
124+
- View table IDs and sizes
125+
- See database size summary
83126
- Create new tables
127+
- Access detailed table schema information
84128

85129
For more information, see [Manage tables](/influxdb3/cloud-dedicated/admin/tables/).
86130

87131
### Manage database tokens
88132

89-
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI manage database tokens portal" />}}
133+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI database tokens" />}}
134+
135+
Use the **Database Tokens** page to manage authentication tokens for database-level operations:
90136

91-
- Create and manage authentication tokens for database-level operations
137+
- Create and manage database tokens with granular permissions
138+
- View token status, descriptions, and associated databases
92139
- Edit permissions or revoke existing tokens
93-
- Control access with granular read and write permissions
140+
- Control access with read and write permissions for specific databases
141+
- Toggle display of inactive tokens
94142

95143
For more information, see [Manage database tokens](/influxdb3/cloud-dedicated/admin/tokens/).
96144

97-
### Additional Features
145+
### Manage management tokens
146+
147+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-management-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI management tokens" />}}
148+
149+
Use the **Management Tokens** page to manage tokens for account-level administrative operations:
150+
151+
- Create and manage management tokens for administrative tasks
152+
- View token status, descriptions, and creation dates
153+
- Manage permissions for users, databases, and database tokens
154+
- Toggle display of inactive tokens
155+
156+
Management tokens grant permission to perform administrative actions such as managing users, databases, and database tokens.
157+
158+
For more information, see [Manage management tokens](/influxdb3/cloud-dedicated/admin/tokens/).
159+
160+
### Manage users
161+
162+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-users.png" alt="InfluxDB Cloud Dedicated Admin UI users" />}}
163+
164+
Use the **Users** page to manage access to your InfluxDB account:
165+
166+
- View all users who have accepted the user agreement and have access to the account
167+
- Invite new users to the account
168+
- View user roles, email addresses, and join dates
169+
- Manage user permissions and access
170+
- Toggle between Users and Invitations tabs
171+
172+
For more information, see [Manage users](/influxdb3/cloud-dedicated/admin/users/).
173+
174+
## Get help and support
175+
176+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-help.png" alt="InfluxDB Cloud Dedicated Admin UI help menu" />}}
177+
178+
The **Help** menu in the sidebar provides quick access to:
179+
180+
- **Documentation**: Browse getting started guides, data operations, queries, visualizations, and reference documentation
181+
- **Contact Us**: Send messages directly to InfluxData support
182+
- **Contact Technical Support**: Open technical support tickets
183+
- **Contact Sales Representative**: Reach out to the sales team for account and contract inquiries
98184

99-
- Help center for access to documentation
100-
- One-click connections to InfluxData sales and support
185+
Access the help menu at any time by clicking the **Help** icon in the sidebar navigation.
682 KB
Loading
452 KB
Loading
517 KB
Loading
660 KB
Loading
407 KB
Loading

0 commit comments

Comments
 (0)