Skip to content

Commit 68b17b4

Browse files
committed
docs: update dedicated admin ui docs
1 parent 84b196b commit 68b17b4

File tree

16 files changed

+199
-397
lines changed

16 files changed

+199
-397
lines changed

content/influxdb3/cloud-dedicated/admin/account/_index.md

Lines changed: 57 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -14,47 +14,75 @@ influxdb3/cloud-dedicated/tags: [clusters]
1414
Use the Admin UI for {{% product-name %}} to view information for your {{% product-name omit="InfluxDB " %}} account.
1515
Your {{% product-name %}} account is a collection of {{% product-name omit="Clustered "%}} clusters and associated resources.
1616

17-
- [Access the Admin UI](#access-the-admin-ui)
18-
- [View account information](#view-account-information)
19-
- [View cluster information](#view-cluster-information)
20-
- [Access operational dashboards](#access-operational-dashboards)
21-
- [Administer management tokens](#administer-management-tokens)
17+
- [Access and Navigate the Admin UI](#access-and-navigate-the-admin-ui)
18+
- [Account and cluster management](#account-and-cluster-management)
19+
- [Get help and support](#get-help-and-support)
2220

23-
## Access the Admin UI
21+
## Access and Navigate the Admin UI
2422

25-
1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser:
23+
Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com).
24+
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
2625

27-
<pre>
28-
<a href="https://console.influxdata.com">https://console.influxdata.com</a>
29-
</pre>
26+
The Admin UI features a collapsible sidebar navigation that provides quick access to all administrative functions:
3027

31-
2. Use the credentials provided by InfluxData to log into the Admin UI.
32-
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
28+
- **Overview**: View cluster details, metrics, and operational status
29+
- **Databases**: Create and manage databases
30+
- **Tables**: View and manage tables within databases
31+
- **Database Tokens**: Create and manage authentication tokens for database operations
32+
- **Management Tokens**: Create and manage tokens for account-level administrative tasks
33+
- **Users**: View and manage user access and invitations
34+
- **Help**: Access documentation, contact support, or reach sales representatives
3335

34-
## View account information
36+
## Account and cluster management
3537

36-
The Admin UI provides access to account information through the **All Accounts** page:
38+
The Admin UI uses a hierarchical navigation system with account and cluster selection at the bottom of the sidebar:
3739

38-
1. Click the **Account** selector at the bottom of the sidebar navigation
39-
2. Select **All Accounts** from the menu
40-
3. View a table with all accounts across your organization
40+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-account-switcher.png" alt="InfluxDB Cloud Dedicated Admin UI account and cluster switcher" />}}
41+
42+
### Switch between accounts
43+
44+
1. Click the **Account** selector at the bottom of the sidebar
45+
2. Search for or select an account from the list
46+
3. The UI updates to show resources for the selected account
47+
48+
### Switch between clusters
49+
50+
1. Click the **Cluster** selector at the bottom of the sidebar
51+
2. Search for or select a cluster from the list
52+
3. The UI updates to show resources for the selected cluster
53+
54+
### View all accounts
55+
56+
To view all accounts across your organization:
57+
58+
1. Click **All Accounts** from the account switcher menu
59+
2. View a list of all accounts with their IDs, status, type, and creation dates
60+
3. Use the search bar to filter accounts by name or ID
4161

4262
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-all-accounts.png" alt="InfluxDB Cloud Dedicated Admin UI all accounts view" />}}
4363

44-
The All Accounts page displays the following information for each account:
64+
### View all clusters
4565

46-
- **Name**: The account name
47-
- **Account ID**: Unique identifier for the account
48-
- **Status**: Current account status (Active, Cancelled, etc.)
49-
- **Type**: Account type
50-
- **Created At**: The date the account was created
66+
To view all clusters in the account:
5167

52-
Use the search bar to filter accounts by name or ID, and access additional actions through the menu on each row.
68+
1. Click **All Clusters** from the cluster switcher menu
69+
2. Navigate to the clusters list to see all available clusters
70+
3. View cluster IDs, status, creation dates, and size information
71+
4. Use available actions to copy cluster IDs or URLs, or observe clusters in Grafana (if enabled)
5372

54-
### Switch between accounts
73+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-all-clusters.png" alt="InfluxDB Cloud Dedicated Admin UI all clusters view" />}}
5574

56-
To switch to a specific account and view its resources:
75+
For more information about managing clusters, see [Manage clusters](/influxdb3/cloud-dedicated/admin/clusters/).
5776

58-
1. Click the **Account** selector at the bottom of the sidebar navigation
59-
2. Search for or select an account from the list
60-
3. The UI updates to show resources (clusters, databases, tokens, users) for the selected account
77+
## Get help and support
78+
79+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-help.png" alt="InfluxDB Cloud Dedicated Admin UI help menu" />}}
80+
81+
The **Help** menu in the sidebar provides quick access to:
82+
83+
- **Documentation**: Browse getting started guides, data operations, queries, visualizations, and reference documentation
84+
- **Contact Us**: Send messages directly to InfluxData support
85+
- **Contact Technical Support**: Open technical support tickets
86+
- **Contact Sales Representative**: Reach out to the sales team for account and contract inquiries
87+
88+
Access the help menu at any time by clicking the **Help** icon in the sidebar navigation.

content/influxdb3/cloud-dedicated/admin/clusters/get.md

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -28,20 +28,8 @@ Use the Admin UI or the [`influxctl cluster get` CLI command](/influxdb3/cloud-d
2828
[influxctl](#)
2929
{{% /tabs %}}
3030
{{% tab-content %}}
31-
## Access the Cloud Dedicated Admin UI
32-
33-
1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser:
34-
35-
<pre>
36-
<a href="https://console.influxdata.com">https://console.influxdata.com</a>
37-
</pre>
38-
39-
2. Use the credentials provided by InfluxData to log into the Admin UI.
40-
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
41-
42-
After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/)
43-
and lists all clusters associated with your account.
44-
3. **Search** for the cluster or use the sort button and column headers to sort the cluster list and find the cluster.
31+
Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com).
32+
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
4533

4634
### View cluster details
4735

@@ -60,6 +48,17 @@ The options button (3 vertical dots) to the right of any cluster provides additi
6048
- Copy Cluster URL
6149
- Observe in Grafana _(only if your cluster has enabled operational dashboards. For more information, see how to [monitor your cluster](/influxdb3/cloud-dedicated/admin/monitor-your-cluster/).)_
6250

51+
### View cluster overview and metrics
52+
53+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-overview.png" alt="InfluxDB Cloud Dedicated Admin UI cluster overview" />}}
54+
55+
After selecting a cluster, the **Overview** page displays real-time cluster information and metrics:
56+
57+
- **Cluster Details**: View cluster name, status, creation date, cluster ID, and cluster URL
58+
- **Cluster Size**: See CPU allocation and component vCPU distribution (Ingest, Compaction, Query, System)
59+
- **Cluster Metrics**: Monitor CPU usage, memory usage, and ingest line protocol rate with time-series charts
60+
- Configure the metrics time range and enable live updates for real-time monitoring
61+
6362
{{% /tab-content %}}
6463
{{% tab-content %}}
6564

content/influxdb3/cloud-dedicated/admin/clusters/list.md

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,8 @@ to view information about all {{< product-name omit=" Clustered" >}} clusters as
2424
[influxctl](#)
2525
{{% /tabs %}}
2626
{{% tab-content %}}
27-
## Access the Cloud Dedicated Admin UI
28-
29-
1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser:
30-
31-
<pre>
32-
<a href="https://console.influxdata.com">https://console.influxdata.com</a>
33-
</pre>
34-
35-
2. Use the credentials provided by InfluxData to log into the Admin UI.
36-
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
37-
38-
After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/)
39-
and lists all clusters associated with your account.
40-
3. You can **Search** clusters by name or ID to filter the list and use the sort button and column headers to sort the list.
27+
Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com).
28+
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
4129

4230
### View cluster details
4331

content/influxdb3/cloud-dedicated/admin/databases/list.md

Lines changed: 3 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,8 @@ or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to list
3535
[Management API](#)
3636
{{% /tabs %}}
3737
{{% tab-content %}}
38-
## Access the Cloud Dedicated Admin UI
39-
40-
1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser:
41-
42-
<pre>
43-
<a href="https://console.influxdata.com">https://console.influxdata.com</a>
44-
</pre>
45-
46-
2. Use the credentials provided by InfluxData to log into the Admin UI.
47-
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
48-
49-
After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/)
50-
and lists all clusters associated with your account.
51-
3. You can **Search** for clusters by name or ID to filter the list and use the sort button and column headers to sort the list.
52-
4. Click the cluster row to view the list of databases associated with the cluster.
38+
Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com).
39+
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
5340

5441
The database list displays the following database details:
5542

@@ -61,7 +48,7 @@ The database list displays the following database details:
6148

6249
You can **Search** for databases by name or ID to filter the list and use the sort button and column headers to sort the list.
6350

64-
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-list-databases.png" alt="List databases" />}}
51+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-databases.png" alt="InfluxDB Cloud Dedicated Admin UI databases list" />}}
6552

6653
### Database management tools
6754

content/influxdb3/cloud-dedicated/admin/databases/update.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,12 @@ Replace the following in your command:
101101

102102
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/)
103103

104-
> [!Warning]
105-
> #### Database names can't be updated
106-
>
104+
> [!Note]
105+
> #### Database names can't be updated with this command
106+
>
107107
> The `influxctl database update` command uses the database name to identify which
108-
> database to apply updates to. The database name itself can't be updated.
108+
> database to apply updates to. To rename a database, use the
109+
> [`influxctl database rename`](/influxdb3/cloud-dedicated/admin/databases/rename/) command.
109110
110111
## Database attributes
111112

@@ -238,17 +239,18 @@ The retention period value cannot be negative or contain whitespace.
238239
{{% /tab-content %}}
239240
{{< /tabs-wrapper >}}
240241

241-
> [!Warning]
242-
>
243-
> #### Database names can't be updated
244-
>
242+
> [!Note]
243+
>
244+
> #### Database names can't be updated with these methods
245+
>
245246
> The Management API `PATCH /api/v0/database` endpoint and
246-
> the`influxctl database update` command use the database name to identify which
247+
> the `influxctl database update` command use the database name to identify which
247248
> database to apply updates to.
248-
> The database name itself can't be updated.
249-
>
249+
> To rename a database, use the
250+
> [`influxctl database rename`](/influxdb3/cloud-dedicated/admin/databases/rename/) command.
251+
>
250252
> #### Partition templates can't be updated
251-
>
253+
>
252254
> You can only apply a partition template when creating a database.
253255
> You can't update a partition template on an existing database.
254256

content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md

Lines changed: 33 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,53 @@
22
title: Monitor your cluster
33
seotitle: Monitor your InfluxDB Cloud Dedicated cluster
44
description: >
5-
Use the Grafana operational dashboard provided by InfluxData to monitor your
5+
Use the Admin UI or Grafana operational dashboards to monitor your
66
InfluxDB Cloud Dedicated cluster.
77
menu:
88
influxdb3_cloud_dedicated:
99
parent: Administer InfluxDB Cloud
1010
weight: 104
1111
---
1212

13-
InfluxData provides a Grafana operational dashboard that provides observability
14-
into your {{< product-name >}} cluster.
15-
Use the operational dashboard to monitor your cluster.
13+
{{% product-name %}} provides multiple ways to monitor your cluster's health and performance:
14+
15+
- [Monitor cluster metrics in the Admin UI](#monitor-cluster-metrics-in-the-admin-ui)
16+
- [Monitor with Grafana operational dashboards](#monitor-with-grafana-operational-dashboards)
17+
18+
## Monitor cluster metrics in the Admin UI
19+
20+
The Admin UI **Overview** page provides real-time monitoring of your cluster's performance and resource usage.
21+
22+
Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com).
23+
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
24+
25+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-overview.png" alt="InfluxDB Cloud Dedicated Admin UI cluster overview" />}}
26+
27+
The Overview page provides:
28+
29+
- **Cluster Details**: View cluster name, status, creation date, cluster ID, and cluster URL
30+
- **Cluster Size**: See CPU allocation and component vCPU distribution (Ingest, Compaction, Query, System)
31+
- **Cluster Metrics**: Monitor CPU usage, memory usage, and ingest line protocol rate with time-series charts
32+
- **Time Range Configuration**: Adjust the metrics time range
33+
- **Live Updates**: Enable automatic refresh for real-time monitoring
34+
35+
## Monitor with Grafana operational dashboards
36+
37+
InfluxData provides Grafana operational dashboards that offer detailed observability
38+
into your {{< product-name >}} cluster components and performance.
1639

1740
> [!Note]
1841
> #### Not available for all clusters
19-
>
42+
>
2043
> {{< product-name >}} operational dashboards are not available for all clusters.
2144
> For questions about availability, [contact InfluxData support](https://support.influxdata.com).
2245
23-
- [Access your operational dashboard](#access-your-operational-dashboard)
46+
- [Access Grafana operational dashboards](#access-grafana-operational-dashboards)
2447
- [Dashboard sections and cells](#dashboard-sections-and-cells)
2548

26-
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-observability-dashboard.png" alt="InfluxDB Cloud Dedicated operational dashboard" />}}
49+
### Access Grafana operational dashboards
2750

28-
## Access your operational dashboard
29-
30-
To access your {{< product-name >}} operational dashboard, visit the
51+
To access your {{< product-name >}} Grafana operational dashboard, visit the
3152
`/observability` endpoint of your {{< product-name >}} cluster in your browser:
3253

3354
<pre>
@@ -37,6 +58,8 @@ To access your {{< product-name >}} operational dashboard, visit the
3758
Use the credentials provided by InfluxData to log into your cluster operational dashboard.
3859
If you do not have login credentials, [contact InfluxData support](https://support.influxdata.com).
3960

61+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-observability-dashboard.png" alt="InfluxDB Cloud Dedicated Grafana operational dashboard" />}}
62+
4063
## Dashboard sections and cells
4164

4265
The dashboard contains the following sections that visualize metrics

content/influxdb3/cloud-dedicated/admin/tables/list.md

Lines changed: 12 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -51,42 +51,23 @@ to list tables in a database.
5151

5252
The InfluxDB Cloud Dedicated administrative UI includes a portal for managing
5353
tables. You can view the list of tables associated with a database and
54-
their details, including:
54+
their details.
5555

56-
- Name
57-
- Table ID
58-
- Table size (in bytes)
56+
Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com).
57+
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
5958

60-
1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser:
59+
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-tables.png" alt="InfluxDB Cloud Dedicated Admin UI tables list" />}}
6160

62-
<pre>
63-
<a href="https://console.influxdata.com">https://console.influxdata.com</a>
64-
</pre>
61+
Use the **Tables** page to manage tables within databases:
6562

66-
2. Use the credentials provided by InfluxData to log into the Admin UI.
67-
If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
63+
- Select a database from the dropdown to view its tables
64+
- View table IDs and sizes
65+
- See database size summary
66+
- Create new tables
67+
- Access detailed table schema information
6868

69-
After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/)
70-
and lists all clusters associated with your account.
71-
72-
3. In the cluster list, find the cluster that contains the database and table.
73-
You can **Search** for clusters by name or ID to filter the list and use the sort button and column headers to sort the list.
74-
4. Click the cluster row to view the list of databases associated with the cluster.
75-
5. In the database list, find the database that contains the table.
76-
You can **Search** for databases by name or ID to filter the list and use
77-
the sort button and column headers to sort the list.
78-
6. Click the database row to view the list of tables associated with the database.
79-
7. The table list displays the following table details:
80-
81-
- Name
82-
- Table ID
83-
- Table size (in bytes)
84-
85-
8. You can **Search** for tables by name or ID to filter the list and use the
86-
sort button and column headers to sort the list.
87-
88-
You can **Search** for databases by name or ID to filter the list and use the
89-
sort button and column headers to sort the list.
69+
You can **Search** for tables by name or ID to filter the list and use the
70+
sort button and column headers to sort the list.
9071

9172
<!-------------------------------- END ADMIN UI ------------------------------->
9273
{{% /tab-content %}}

0 commit comments

Comments
 (0)