Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 63 additions & 19 deletions content/influxdb3/cloud-dedicated/admin/account/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,74 @@ influxdb3/cloud-dedicated/tags: [clusters]
Use the Admin UI for {{% product-name %}} to view information for your {{% product-name omit="InfluxDB " %}} account.
Your {{% product-name %}} account is a collection of {{% product-name omit="Clustered "%}} clusters and associated resources.

- [Access the Admin UI](#access-the-admin-ui)
- [View account information](#view-account-information)
- [View cluster information](#view-cluster-information)
- [Access operational dashboards](#access-operational-dashboards)
Copy link
Contributor

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)

- [Administer management tokens](#administer-management-tokens)
- [Access and Navigate the Admin UI](#access-and-navigate-the-admin-ui)
- [Account and cluster management](#account-and-cluster-management)
- [Get help and support](#get-help-and-support)

## Access the Admin UI
## Access and Navigate the Admin UI

1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser:
{{< admin-ui-access >}}

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

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).
- **Overview**: View cluster details, metrics, and operational status
- **Databases**: Create and manage databases
- **Tables**: View and manage tables within databases
- **Database Tokens**: Create and manage authentication tokens for database operations
- **Management Tokens**: Create and manage tokens for account-level administrative tasks
- **Users**: View and manage user access and invitations
- **Help**: Access documentation, contact support, or reach sales representatives

## View account information
## Account and cluster management

After you log in to the Admin UI, the Account Management portal displays the following information about your account:
The Admin UI uses a hierarchical navigation system with account and cluster selection at the bottom of the sidebar:

- Account ID
- Contract status
- Contract start date
- The [list of clusters](/influxdb3/cloud-dedicated/admin/clusters/list/?t=admin-ui) associated with the account
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-account-switcher.png" alt="InfluxDB Cloud Dedicated Admin UI account and cluster switcher" />}}

{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-account-info.png" alt="InfluxDB Cloud Dedicated Admin UI account information" />}}
### Switch between accounts

1. Click the **Account** selector at the bottom of the sidebar.
2. Search for or select an account from the list.
3. The UI updates to show resources for the selected account.

### Switch between clusters

1. Click the **Cluster** selector at the bottom of the sidebar.
2. Search for or select a cluster from the list.
3. The UI updates to show resources for the selected cluster.

### View all accounts

To view all accounts across your organization:

1. Click **All Accounts** from the account switcher menu.
2. View a list of all accounts with their IDs, status, type, and creation dates.
3. Use the search bar to filter accounts by name or ID.

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

### View all clusters

To view all clusters in the account:

1. Click **All Clusters** from the cluster switcher menu.
2. Navigate to the clusters list to see all available clusters.
3. View cluster IDs, status, creation dates, and size information.
4. Use available actions to copy cluster IDs or URLs, or observe clusters in Grafana (if enabled).

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

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

## Get help and support

{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-help.png" alt="InfluxDB Cloud Dedicated Admin UI help menu" />}}

The **Help** menu in the sidebar provides quick access to:

- **Documentation**: Browse getting started guides, data operations, queries, visualizations, and reference documentation
- **Contact Us**: Send messages directly to InfluxData support
- **Contact Technical Support**: Open technical support tickets
- **Contact Sales Representative**: Reach out to the sales team for account and contract inquiries

Access the help menu at any time by clicking the **Help** icon in the sidebar navigation.
26 changes: 12 additions & 14 deletions content/influxdb3/cloud-dedicated/admin/clusters/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The 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

Expand All @@ -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 %}}

Expand Down
15 changes: 1 addition & 14 deletions content/influxdb3/cloud-dedicated/admin/clusters/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,20 +24,7 @@ to view information about all {{< product-name omit=" Clustered" >}} clusters as
[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. You can **Search** clusters by name or ID to filter the list and use the sort button and column headers to sort the list.
{{< admin-ui-access >}}

### View cluster details

Expand Down
18 changes: 2 additions & 16 deletions content/influxdb3/cloud-dedicated/admin/databases/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,7 @@ or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to list
[Management API](#)
{{% /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. 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.
4. Click the cluster row to view the list of databases associated with the cluster.
{{< admin-ui-access >}}

The database list displays the following database details:

Expand All @@ -61,7 +47,7 @@ The database list displays the following database details:

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.

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

### Database management tools

Expand Down
26 changes: 14 additions & 12 deletions content/influxdb3/cloud-dedicated/admin/databases/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The 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

Expand Down Expand Up @@ -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.

Expand Down
42 changes: 32 additions & 10 deletions content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The 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>
Expand All @@ -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
Expand Down
42 changes: 11 additions & 31 deletions content/influxdb3/cloud-dedicated/admin/tables/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,42 +51,22 @@ to list tables in a database.

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

- Name
- Table ID
- Table size (in bytes)
{{< admin-ui-access >}}

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

<pre>
<a href="https://console.influxdata.com">https://console.influxdata.com</a>
</pre>
Use the **Tables** page to manage tables within databases:

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).
- Select a database from the dropdown to view its tables.
- View table IDs and sizes.
- See database size summary.
- Create new tables.
- Access detailed table schema information.

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. In the cluster list, find the cluster that contains the database and table.
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.
4. Click the cluster row to view the list of databases associated with the cluster.
5. In the database list, find the database that contains the table.
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.
6. Click the database row to view the list of tables associated with the database.
7. The table list displays the following table details:

- Name
- Table ID
- Table size (in bytes)

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

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.
You can **Search** for tables by name or ID to filter the list and use the
sort button and column headers to sort the list.

<!-------------------------------- END ADMIN UI ------------------------------->
{{% /tab-content %}}
Expand Down
Loading