diff --git a/content/influxdb3/cloud-dedicated/admin/account/_index.md b/content/influxdb3/cloud-dedicated/admin/account/_index.md index 852e78438d..e1d6a77819 100644 --- a/content/influxdb3/cloud-dedicated/admin/account/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/account/_index.md @@ -14,30 +14,75 @@ 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) -- [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: +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). -
-   https://console.influxdata.com
-   
+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. diff --git a/content/influxdb3/cloud-dedicated/admin/clusters/get.md b/content/influxdb3/cloud-dedicated/admin/clusters/get.md index 1e8fcec38b..c426bb4251 100644 --- a/content/influxdb3/cloud-dedicated/admin/clusters/get.md +++ b/content/influxdb3/cloud-dedicated/admin/clusters/get.md @@ -28,20 +28,8 @@ 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: - -
-   https://console.influxdata.com
-   
- -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. +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). ### View cluster details @@ -60,6 +48,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 %}} diff --git a/content/influxdb3/cloud-dedicated/admin/clusters/list.md b/content/influxdb3/cloud-dedicated/admin/clusters/list.md index 42f560d99f..3abc2287b8 100644 --- a/content/influxdb3/cloud-dedicated/admin/clusters/list.md +++ b/content/influxdb3/cloud-dedicated/admin/clusters/list.md @@ -24,20 +24,8 @@ 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: - -
-   https://console.influxdata.com
-   
- -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. +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). ### View cluster details diff --git a/content/influxdb3/cloud-dedicated/admin/databases/list.md b/content/influxdb3/cloud-dedicated/admin/databases/list.md index b696c7a0cf..a77134314a 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/list.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/list.md @@ -35,21 +35,8 @@ 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: - -
-   https://console.influxdata.com
-   
- -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. +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). The database list displays the following database details: @@ -61,7 +48,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 diff --git a/content/influxdb3/cloud-dedicated/admin/databases/update.md b/content/influxdb3/cloud-dedicated/admin/databases/update.md index de250dc3ed..9c6507b0c2 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/update.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/update.md @@ -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 +> > 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. diff --git a/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md b/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md index d4ae8c139e..800dd3e5fd 100644 --- a/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md +++ b/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md @@ -2,7 +2,7 @@ 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: @@ -10,24 +10,45 @@ menu: 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. + +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). + +{{< 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 + +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:
@@ -37,6 +58,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
diff --git a/content/influxdb3/cloud-dedicated/admin/tables/list.md b/content/influxdb3/cloud-dedicated/admin/tables/list.md
index e900c5b24d..caa59d3475 100644
--- a/content/influxdb3/cloud-dedicated/admin/tables/list.md
+++ b/content/influxdb3/cloud-dedicated/admin/tables/list.md
@@ -51,42 +51,23 @@ 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) 
+Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com).
+If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com).
 
-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" />}}
 
-    
-    https://console.influxdata.com
-    
+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. {{% /tab-content %}} diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md index ea40d47682..641435a8b2 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md @@ -28,15 +28,19 @@ list_code_example: | --header 'Content-Type: application/json' \ --header "Authorization: Bearer MANAGEMENT_TOKEN" \ --data '{ - "description": "Read/write token for DATABASE_NAME", + "description": "Read-only on DATABASE1_NAME, Read/write on DATABASE2_NAME", "permissions": [ { - "action": "write", - "resource": "DATABASE_NAME" + "action": "read", + "resource": "DATABASE1_NAME" }, { "action": "read", - "resource": "DATABASE_NAME" + "resource": "DATABASE2_NAME" + }, + { + "action": "write", + "resource": "DATABASE2_NAME" } ], "expirationType": "datetime", @@ -66,20 +70,10 @@ or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to crea The InfluxDB Cloud Dedicated administrative UI includes a portal for creating and managing database tokens. -1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser: - -
-    https://{{< influxdb/host >}}
-    
+Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). -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). -3. After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/) - and the list of clusters associated with your account. -4. Find the cluster that you want to create a database token for. You can **Search** clusters by name or ID to filter the list and use the sort button and column headers to sort the list. -5. Click the row for the cluster. -6. Click the **Database Tokens** button in the upper right corner of the Cluster screen. -7. In the Database Tokens portal, click the **New Database Token** button. +In the Database Tokens portal, click the **New Database Token** button. The **Create Database Token** dialog displays. {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-create-database-token.png" alt="Create database token dialog" />}} @@ -483,7 +477,7 @@ curl \ { "action": "write", "resource": "DATABASE2_NAME" - }, + } ] }' ``` diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md index a67f7f268c..c39d6d4eca 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md @@ -63,18 +63,18 @@ Administrators can use this portal to: - Create a database token - Revoke a database token -1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser: - -
-    https://{{< influxdb/host >}}
-    
- -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). -3. After you log in, the Account Management screen displays [account information](/influxdb3/cloud-dedicated/admin/account/) - and the list of clusters associated with your account. -4. Click the cluster row that you want to manage tokens for. You can **Search** clusters by name or ID to filter the list and use the sort button and column headers to sort the list. -5. Click the **Database Tokens** button in the upper right corner of the Cluster screen. +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). + +{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI database tokens" />}} + +Use the **Database Tokens** page to manage authentication tokens for database-level operations: + +- Create and manage database tokens with granular permissions. +- View token status, descriptions, and associated databases. +- Edit permissions or revoke existing tokens. +- Control access with read and write permissions for specific databases. +- Toggle display of inactive tokens. The Database Tokens portal lists all database tokens associated with the cluster and provides the following information about each token: diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md index df870c745b..67b0f9ea9b 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md @@ -56,19 +56,10 @@ Administrators can use this portal to: - Create a database token - Revoke a database token -1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser: - -
-    https://{{< influxdb/host >}}
-    
- -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). -3. After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/) - and the [list of clusters](/influxdb3/cloud-dedicated/admin/clusters/list/) associated with your account. -4. Click the row for the cluster that contains the database you want to manage tokens for. You can **Search** clusters by name or ID to filter the list and use the sort button and column headers to sort the list. -5. Click the **Database Tokens** button in the upper right corner of the Cluster screen. -6. The Database Tokens portal displays the [list of database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/list/) associated with the cluster. +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). + +The Database Tokens portal displays the [list of database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/list/) associated with the cluster. Use the sort and filter options above the list to find a specific token. 7. Click the **Options** button (three vertical dots) to the right of the token you want to revoke. 8. In the options menu, click **Revoke Token**. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md index c438610778..bc2632f081 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md @@ -37,7 +37,7 @@ list_code_example: | "resource": "DATABASE2_NAME" }, { - "action": "read", + "action": "write", "resource": "DATABASE2_NAME" } ] @@ -74,20 +74,10 @@ Through this portal, administrators can edit a token's permissions to: ### Open the Edit Database Token dialog -1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser: - -
-    https://{{< influxdb/host >}}
-    
+Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). -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). -3. After you log in, the Account Management portal displays [account information](/influxdb3/cloud-dedicated/admin/account/) - and the [list of clusters](/influxdb3/cloud-dedicated/admin/clusters/list/) associated with your account. - Use the sort and filter options above the list to find a specific cluster. -4. Click the row for the cluster that contains the database you want to manage tokens for. -5. Click the **Database Tokens** button in the upper right corner of the Cluster screen. -6. The Database Tokens portal displays the [list of database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/list/) associated with the cluster. +The Database Tokens portal displays the [list of database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/list/) associated with the cluster. Use the sort and filter options above the list to find a specific token. 7. Click the **Options** button (three vertical dots) to the right of the token you want to edit. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md index a63ff2efda..347be9aed3 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md @@ -30,24 +30,27 @@ to list manually-created management tokens. The InfluxDB Cloud Dedicated administrative UI includes a portal for creating and managing management tokens. -1. To access the {{< product-name >}} Admin UI, visit the following URL in your browser: +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). -
-   https://console.influxdata.com
-   
+{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-management-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI management tokens" />}} -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). +Use the **Management Tokens** page to manage tokens for account-level administrative operations: -3. To list management tokens, click the **Management Tokens** button in the upper right corner of the Account Management portal. +- Create and manage management tokens for administrative tasks. +- View token status, descriptions, and creation dates. +- Manage permissions for users, databases, and database tokens. +- Toggle display of inactive tokens. + +Management tokens grant permission to perform administrative actions such as managing users, databases, and database tokens. The Management Tokens portal displays the following information about each token: - Status - Description - Token ID -- Created date -- Expiration date +- Created date +- Expiration date You can **Search** tokens by description or ID to filter the list and use the sort button and column headers to sort the list. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md index 8c17f67583..3cf7930a76 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md @@ -28,15 +28,10 @@ to revoke a management token and remove all access associated with the token. The {{% product-name %}} administrative UI includes a portal for managing management tokens. -1. To access the {{< product-name omit="InfluxDB " >}} Admin UI, visit the following URL in your browser: +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). -
-    https://{{< influxdb/host >}}
-    
-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). -3. To revoke a management token, click the **Management Tokens** button in the upper right corner of the Account Management portal. -4. **Search** for the token or use the sort button and column headers to sort the token list and find the token you want to revoke. +**Search** for the token or use the sort button and column headers to sort the token list and find the token you want to revoke. 5. Click the options button (three vertical dots) to the right of the token you want to revoke. The options menu displays. 6. In the options menu, click **Revoke Token**. diff --git a/content/influxdb3/cloud-dedicated/admin/users/admin-ui.md b/content/influxdb3/cloud-dedicated/admin/users/admin-ui.md index 56fb32abcc..72ce61bd91 100644 --- a/content/influxdb3/cloud-dedicated/admin/users/admin-ui.md +++ b/content/influxdb3/cloud-dedicated/admin/users/admin-ui.md @@ -28,13 +28,18 @@ Use the {{% product-name %}} Admin UI to manage users and control access to your ## Access the Users page -1. Access the {{% product-name %}} Admin UI at [console.influxdata.com](https://console.influxdata.com). - If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). -2. Log in using the credentials provided by InfluxData. -3. From the Account Management portal, select your cluster. -4. In the cluster resource management view, click **Users** in the navigation. +Access the InfluxDB Cloud Dedicated Admin UI at [console.influxdata.com](https://console.influxdata.com). +If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). -The Users page displays your account information and a table of existing users and invitations. +{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-users.png" alt="InfluxDB Cloud Dedicated Admin UI users" />}} + +The Users page displays your account information and a table of existing users and invitations. Use the **Users** page to manage access to your InfluxDB account: + +- View all users who have accepted the user agreement and have access to the account +- Invite new users to the account +- View user roles, email addresses, and join dates +- Manage user permissions and access +- Toggle between Users and Invitations tabs ## View existing users diff --git a/content/influxdb3/cloud-dedicated/reference/admin-ui.md b/content/influxdb3/cloud-dedicated/reference/admin-ui.md deleted file mode 100644 index eef8a8cc61..0000000000 --- a/content/influxdb3/cloud-dedicated/reference/admin-ui.md +++ /dev/null @@ -1,100 +0,0 @@ ---- -title: Administrative UI -seotitle: Administrative UI for {{% product-name %}} -description: > - 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. -menu: - influxdb3_cloud_dedicated: - parent: Reference -weight: 105 ---- - -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. - -- [Access the Admin UI](#access-the-admin-ui) -- [Account management](#account-management) -- [Resource management](#resource-management) - - [Manage clusters](#manage-clusters) - - [Manage databases](#manage-databases) - - [Manage tables](#manage-tables) - - [Manage database tokens](#manage-database-tokens) - - [Additional Features](#additional-features) - - -## Access the Admin UI - -{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-login.png" alt="InfluxDB Cloud Dedicated Admin UI login page" />}} - -Customers can access the Admin UI at [console.influxdata.com](http://console.influxdata.com) using the credentials provided by InfluxData. -If you don't have login credentials, [contact InfluxData support](https://support.influxdata.com). - -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. - -## Account management - -{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png" alt="InfluxDB Cloud Dedicated Admin UI account management cluster list" />}} - -- View account details and associated clusters -- Create, view, and manage management tokens for account-level operations -- Access contract information (status, start date) - -For more information, see the following: - -- [View account information](/influxdb3/cloud-dedicated/admin/account/) -- [Manage management tokens](/influxdb3/cloud-dedicated/admin/tokens/) - -## Resource management - -The Admin UI lets you manage {{% product-name %}} resources, such as databases, -tables, and tokens, associated with a cluster. - -- [Manage clusters](#manage-clusters) -- [Manage databases](#manage-databases) -- [Manage tables](#manage-tables) -- [Manage database tokens](manage-database-tokens) - -### Manage clusters - -{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png" alt="InfluxDB Cloud Dedicated Admin UI cluster options" />}} - -- View cluster IDs, statuses, creation date, and sizing information -- Access Grafana dashboards for operational monitoring (if enabled for the account) -- View and manage resources (such as databases, tables, and database tokens) associated with a cluster - -For more information, see [Manage clusters](/influxdb3/cloud-dedicated/admin/clusters/). - -### Manage databases - -{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-databases.png" alt="InfluxDB Cloud Dedicated Admin UI cluster resources databases list" />}} - -- Create and delete databases -- Update retention periods -- Configure maximum tables and columns per table -- View and manage tables associated with a database - -For more information, see [Manage databases](/influxdb3/cloud-dedicated/admin/databases/). - -### Manage tables - -{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-tables.png" alt="InfluxDB Cloud Dedicated Admin UI database tables list" />}} - -- View tables associated with databases -- See table IDs and sizes -- Create new tables - -For more information, see [Manage tables](/influxdb3/cloud-dedicated/admin/tables/). - -### Manage database tokens - -{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI manage database tokens portal" />}} - -- Create and manage authentication tokens for database-level operations -- Edit permissions or revoke existing tokens -- Control access with granular read and write permissions - -For more information, see [Manage database tokens](/influxdb3/cloud-dedicated/admin/tokens/). - -### Additional Features - -- Help center for access to documentation -- One-click connections to InfluxData sales and support diff --git a/content/influxdb3/clustered/admin/databases/update.md b/content/influxdb3/clustered/admin/databases/update.md index 3fafb3ee96..6cfb99f1c3 100644 --- a/content/influxdb3/clustered/admin/databases/update.md +++ b/content/influxdb3/clustered/admin/databases/update.md @@ -49,11 +49,12 @@ Replace the following in your command: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/) -> [!Warning] -> #### Database names can't be updated -> +> [!Note] +> #### Database names can't be updated with this command +> > 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/clustered/admin/databases/rename/) command. ## Database attributes diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-account-info.png b/static/img/influxdb3/cloud-dedicated-admin-ui-account-info.png deleted file mode 100644 index 083063c907..0000000000 Binary files a/static/img/influxdb3/cloud-dedicated-admin-ui-account-info.png and /dev/null differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-account-switcher.png b/static/img/influxdb3/cloud-dedicated-admin-ui-account-switcher.png new file mode 100644 index 0000000000..9c0036cc67 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-account-switcher.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-all-accounts.png b/static/img/influxdb3/cloud-dedicated-admin-ui-all-accounts.png new file mode 100644 index 0000000000..dd6c06987d Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-all-accounts.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-all-clusters.png b/static/img/influxdb3/cloud-dedicated-admin-ui-all-clusters.png new file mode 100644 index 0000000000..0bd998dd0b Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-all-clusters.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png b/static/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png deleted file mode 100644 index d63dc816eb..0000000000 Binary files a/static/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png and /dev/null differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png b/static/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png index ab562b04a1..463d3293b2 100644 Binary files a/static/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png and b/static/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-databases.png b/static/img/influxdb3/cloud-dedicated-admin-ui-databases.png index 971c4bb432..73d71b77e1 100644 Binary files a/static/img/influxdb3/cloud-dedicated-admin-ui-databases.png and b/static/img/influxdb3/cloud-dedicated-admin-ui-databases.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-help.png b/static/img/influxdb3/cloud-dedicated-admin-ui-help.png new file mode 100644 index 0000000000..ec01c4a77f Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-help.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-list-databases.png b/static/img/influxdb3/cloud-dedicated-admin-ui-list-databases.png index 79024ee70a..04a20cf040 100644 Binary files a/static/img/influxdb3/cloud-dedicated-admin-ui-list-databases.png and b/static/img/influxdb3/cloud-dedicated-admin-ui-list-databases.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-management-tokens.png b/static/img/influxdb3/cloud-dedicated-admin-ui-management-tokens.png new file mode 100644 index 0000000000..1e6f3b6fb3 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-management-tokens.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-overview.png b/static/img/influxdb3/cloud-dedicated-admin-ui-overview.png new file mode 100644 index 0000000000..25b3497f30 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-overview.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-tables.png b/static/img/influxdb3/cloud-dedicated-admin-ui-tables.png index da6714813e..060204251d 100644 Binary files a/static/img/influxdb3/cloud-dedicated-admin-ui-tables.png and b/static/img/influxdb3/cloud-dedicated-admin-ui-tables.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-users.png b/static/img/influxdb3/cloud-dedicated-admin-ui-users.png new file mode 100644 index 0000000000..b74fe5cfe6 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-users.png differ