-
Notifications
You must be signed in to change notification settings - Fork 321
chore: update Admin UI doc to reflect the new UI design #6528
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
e6e80d2
6108483
84b196b
365a1c1
bb434e7
2ff1b24
36e8563
480ee39
c7fc09b
09cd1f2
9dba2c8
fdc1ad2
0726900
4e71b96
d14cc75
fd59414
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -28,20 +28,7 @@ Use the Admin UI or the [`influxctl cluster get` CLI command](/influxdb3/cloud-d | |
| [influxctl](#) | ||
| {{% /tabs %}} | ||
| {{% tab-content %}} | ||
| ## Access the Cloud Dedicated Admin UI | ||
|
|
||
| 1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser: | ||
|
|
||
| <pre> | ||
| <a href="https://console.influxdata.com">https://console.influxdata.com</a> | ||
| </pre> | ||
|
|
||
| 2. Use the credentials provided by InfluxData to log into the Admin UI. | ||
| If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). | ||
|
|
||
| After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/) | ||
| and lists all clusters associated with your account. | ||
| 3. **Search** for the cluster or use the sort button and column headers to sort the cluster list and find the cluster. | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We could leave all of this in, but I found this a little repetitive; for purposes of opening the application I think providing the URL and request to contact support if credentials are required is sufficient. |
||
| {{< admin-ui-access >}} | ||
|
|
||
| ### View cluster details | ||
|
|
||
|
|
@@ -60,6 +47,17 @@ The options button (3 vertical dots) to the right of any cluster provides additi | |
| - Copy Cluster URL | ||
| - 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/).)_ | ||
|
|
||
| ### View cluster overview and metrics | ||
|
|
||
| {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-overview.png" alt="InfluxDB Cloud Dedicated Admin UI cluster overview" />}} | ||
|
|
||
| After selecting a cluster, the **Overview** page displays real-time cluster information and metrics: | ||
|
|
||
| - **Cluster Details**: View cluster name, status, creation date, cluster ID, and cluster URL. | ||
| - **Cluster Size**: See CPU allocation and component vCPU distribution (Ingest, Compaction, Query, System). | ||
| - **Cluster Metrics**: Monitor CPU usage, memory usage, and ingest line protocol rate with time-series charts. | ||
| - Configure the metrics time range and enable live updates for real-time monitoring. | ||
|
|
||
| {{% /tab-content %}} | ||
| {{% tab-content %}} | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -101,11 +101,12 @@ Replace the following in your command: | |
|
|
||
| - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/) | ||
|
|
||
| > [!Warning] | ||
| > #### Database names can't be updated | ||
| > | ||
| > [!Note] | ||
| > #### Database names can't be updated with this command | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I edited this because there is a database rename command in influxctl now. |
||
| > | ||
| > The `influxctl database update` command uses the database name to identify which | ||
| > database to apply updates to. The database name itself can't be updated. | ||
| > database to apply updates to. To rename a database, use the | ||
| > [`influxctl database rename`](/influxdb3/cloud-dedicated/admin/databases/rename/) command. | ||
|
|
||
| ## Database attributes | ||
|
|
||
|
|
@@ -238,17 +239,18 @@ The retention period value cannot be negative or contain whitespace. | |
| {{% /tab-content %}} | ||
| {{< /tabs-wrapper >}} | ||
|
|
||
| > [!Warning] | ||
| > | ||
| > #### Database names can't be updated | ||
| > | ||
| > [!Note] | ||
| > | ||
| > #### Database names can't be updated with these methods | ||
| > | ||
| > The Management API `PATCH /api/v0/database` endpoint and | ||
| > the`influxctl database update` command use the database name to identify which | ||
| > the `influxctl database update` command use the database name to identify which | ||
| > database to apply updates to. | ||
| > The database name itself can't be updated. | ||
| > | ||
| > To rename a database, use the | ||
| > [`influxctl database rename`](/influxdb3/cloud-dedicated/admin/databases/rename/) command. | ||
| > | ||
| > #### Partition templates can't be updated | ||
| > | ||
| > | ||
| > You can only apply a partition template when creating a database. | ||
| > You can't update a partition template on an existing database. | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,32 +2,52 @@ | |
| title: Monitor your cluster | ||
| seotitle: Monitor your InfluxDB Cloud Dedicated cluster | ||
| description: > | ||
| Use the Grafana operational dashboard provided by InfluxData to monitor your | ||
| Use the Admin UI or Grafana operational dashboards to monitor your | ||
| InfluxDB Cloud Dedicated cluster. | ||
| menu: | ||
| influxdb3_cloud_dedicated: | ||
| parent: Administer InfluxDB Cloud | ||
| weight: 104 | ||
| --- | ||
|
|
||
| InfluxData provides a Grafana operational dashboard that provides observability | ||
| into your {{< product-name >}} cluster. | ||
| Use the operational dashboard to monitor your cluster. | ||
| {{% product-name %}} provides multiple ways to monitor your cluster's health and performance: | ||
|
|
||
| - [Monitor cluster metrics in the Admin UI](#monitor-cluster-metrics-in-the-admin-ui) | ||
| - [Monitor with Grafana operational dashboards](#monitor-with-grafana-operational-dashboards) | ||
|
|
||
| ## Monitor cluster metrics in the Admin UI | ||
|
|
||
| The Admin UI **Overview** page provides real-time monitoring of your cluster's performance and resource usage. | ||
|
|
||
| {{< admin-ui-access >}} | ||
|
|
||
| {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-overview.png" alt="InfluxDB Cloud Dedicated Admin UI cluster overview" />}} | ||
|
|
||
| The Overview page provides: | ||
|
|
||
| - **Cluster Details**: View cluster name, status, creation date, cluster ID, and cluster URL. | ||
| - **Cluster Size**: See CPU allocation and component vCPU distribution (Ingest, Compaction, Query, System). | ||
| - **Cluster Metrics**: Monitor CPU usage, memory usage, and ingest line protocol rate with time-series charts. | ||
| - **Time Range Configuration**: Adjust the metrics time range. | ||
| - **Live Updates**: Enable automatic refresh for real-time monitoring. | ||
|
|
||
| ## Monitor with Grafana operational dashboards | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @ritwika314 I imagine we should keep the Grafana operational dashboards instructions at least for now. |
||
|
|
||
| InfluxData provides Grafana operational dashboards that offer detailed observability | ||
| into your {{< product-name >}} cluster components and performance. | ||
|
|
||
| > [!Note] | ||
| > #### Not available for all clusters | ||
| > | ||
| > | ||
| > {{< product-name >}} operational dashboards are not available for all clusters. | ||
| > For questions about availability, [contact InfluxData support](https://support.influxdata.com). | ||
|
|
||
| - [Access your operational dashboard](#access-your-operational-dashboard) | ||
| - [Access Grafana operational dashboards](#access-grafana-operational-dashboards) | ||
| - [Dashboard sections and cells](#dashboard-sections-and-cells) | ||
|
|
||
| {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-observability-dashboard.png" alt="InfluxDB Cloud Dedicated operational dashboard" />}} | ||
| ### Access Grafana operational dashboards | ||
|
|
||
| ## Access your operational dashboard | ||
|
|
||
| To access your {{< product-name >}} operational dashboard, visit the | ||
| To access your {{< product-name >}} Grafana operational dashboard, visit the | ||
| `/observability` endpoint of your {{< product-name >}} cluster in your browser: | ||
|
|
||
| <pre> | ||
|
|
@@ -37,6 +57,8 @@ To access your {{< product-name >}} operational dashboard, visit the | |
| Use the credentials provided by InfluxData to log into your cluster operational dashboard. | ||
| If you do not have login credentials, [contact InfluxData support](https://support.influxdata.com). | ||
|
|
||
| {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-observability-dashboard.png" alt="InfluxDB Cloud Dedicated Grafana operational dashboard" />}} | ||
|
|
||
| ## Dashboard sections and cells | ||
|
|
||
| The dashboard contains the following sections that visualize metrics | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The 'operational dashboards' and 'management tokens' anchors are the ones that weren't on this page (so existing links didn't work)