Merge pull request #6028 from influxdata/6023-admin-ui-docs-for-cloud-dedicated

6023 admin UI docs for cloud dedicated

Author: jstirnaman

.github/copilot-instructions.md

@@ -103,11 +103,13 @@ GitHub Copilot should help document InfluxData products by creating clear, accur
     product_version:
   weight: # Page order (1-99, 101-199, etc.)
   ```
-- Follow the shortcode documentation in `CONTRIBUTING.md`
+- Follow the shortcode examples in `content/example.md` and the documentation
+  for docs-v2 contributors in `CONTRIBUTING.md`
 - Use provided shortcodes correctly:
   - Notes/warnings: `{{% note %}}`, `{{% warn %}}`
   - Product-specific: `{{% enterprise %}}`, `{{% cloud %}}`
   - Tabbed content: `{{< tabs-wrapper >}}`, `{{% tabs %}}`, `{{% tab-content %}}`
+  - Tabbed content for code examples (without additional text): `{{< code-tabs-wrapper >}}`, `{{% code-tabs %}}`, `{{% code-tab-content %}}`
   - Version links: `{{< latest >}}`, `{{< latest-patch >}}`
   - API endpoints: `{{< api-endpoint >}}`
   - Required elements: `{{< req >}}`

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

@@ -0,0 +1,43 @@
+---
+title: View account information
+seotitle: View {{% product-name %}} account information
+description: >
+  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.
+menu:
+  influxdb3_cloud_dedicated:
+    parent: Administer InfluxDB Cloud
+weight: 99
+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 the 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).
+
+## View account information
+
+After you log in to the Admin UI, the Account Management portal displays the following information about your account:
+
+- 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-info.png" alt="InfluxDB Cloud Dedicated Admin UI account information" />}}

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

@@ -1,7 +1,7 @@
 ---
 title: Get cluster information
 description: >
-  Use the
+  Use the Admin UI or the
   [`influxctl cluster get <CLUSTER_ID>` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/get/) to view information about your InfluxDB Cloud Dedicated cluster.
 menu:
   influxdb3_cloud_dedicated:
@@ -13,8 +13,55 @@ list_code_example: |
   ```
 ---
 
-Use the [`influxctl cluster get` CLI command](/influxdb3/cloud-dedicated/reference/cli/influxctl/get/)
-to view information about your {{< product-name omit=" Clustered" >}} cluster.
+Use the Admin UI or the [`influxctl cluster get` CLI command](/influxdb3/cloud-dedicated/reference/cli/influxctl/get/) to view information about your
+{{< product-name omit=" Clustered" >}} cluster, including:
+
+- Cluster ID
+- Cluster name
+- Cluster URL
+- Cluster status
+- Cluster size (standard or custom)
+
+{{< tabs-wrapper >}}
+{{% tabs %}}
+[Admin UI](#)
+[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.
+
+### View cluster details
+
+The cluster list displays the following cluster details:
+
+- Cluster ID and name
+- Status (ready, provisioning, etc.)
+- Size (standard or custom)
+- URL endpoint
+
+### Cluster management tools
+
+The options button (3 vertical dots) to the right of any cluster provides additional tools for cluster management:
+
+- Copy Cluster ID
+- 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/).)_
+
+{{% /tab-content %}}
+{{% tab-content %}}
 
 1.  If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure a connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster.
 2.  Run `influxctl cluster get` with the following:
@@ -74,3 +121,5 @@ The output is the cluster as a JSON object that includes additional fields such
     "category": 1
 }
 ```
+{{% /tab-content %}}
+{{< /tabs-wrapper >}}

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

@@ -1,7 +1,7 @@
 ---
 title: List clusters
 description: >
-  Use the [`influxctl cluster list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/list/)
+  Use the Admin UI or the [`influxctl cluster list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/list/)
   to view information about InfluxDB Cloud Dedicated clusters associated with your account ID.
 menu:
   influxdb3_cloud_dedicated:
@@ -15,10 +15,45 @@ aliases:
   - /influxdb3/cloud-dedicated/admin/clusters/list/
 ---
 
-Use the [`influxctl cluster list` CLI command](/influxdb3/cloud-dedicated/reference/cli/influxctl/list/)
-view information about all {{< product-name omit=" Clustered" >}} clusters associated with your account ID.
+Use the Admin UI or the [`influxctl cluster list` CLI command](/influxdb3/cloud-dedicated/reference/cli/influxctl/list/)
+to view information about all {{< product-name omit=" Clustered" >}} clusters associated with your account ID.
+
+{{< tabs-wrapper >}}
+{{% tabs %}}
+[Admin UI](#)
+[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. 
+
+### View cluster details
+
+The cluster list displays the following cluster details:
+
+- Cluster ID and name
+- Status (ready, provisioning, etc.)
+- Size (standard or custom)
+- URL endpoint
+{{% /tab-content %}}
+{{% tab-content %}}
+
+## Use the CLI
 
 1.  If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure a connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster.
+
 2.  Run `influxctl cluster list` with the following:
 
     - _Optional_: [Output format](#output-formats)
@@ -69,3 +104,6 @@ The output is a JSON array of cluster objects that include additional fields suc
   }
 ]
 ```
+{{% /tab-content %}}
+{{< /tabs-wrapper >}}
+

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

@@ -1,7 +1,7 @@
 ---
 title: Create a database
 description: >
-  Use the [`influxctl database create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/)
+  Use the Admin UI, the [`influxctl database create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/),
   or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
   to create a new InfluxDB database in your InfluxDB Cloud Dedicated cluster.
   Provide a database name and an optional retention period.
@@ -70,16 +70,43 @@ related:
   - /influxdb3/cloud-dedicated/reference/api/
 ---
 
-Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/)
+Use the Admin UI, the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/),
 or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster.
 
 {{< tabs-wrapper >}}
 {{% tabs %}}
+[Admin UI](#)
 [influxctl](#)
 [Management API](#)
 {{% /tabs %}}
 {{% tab-content %}}
-
+<!------------------------------- BEGIN ADMIN UI ------------------------------>
+The InfluxDB Cloud Dedicated administrative UI includes a portal for creating
+and managing databases.
+
+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).
+3. In the cluster list, find the cluster you want to create a database in. You
+   can sort on column headers or use the **Search** field to find a specific cluster.
+4. Click the row for the cluster that you want to create a database in.
+5. Click the **New Database** button in the upper right corner of the cluster details page. 
+   The **Create Database** dialog displays.
+
+    <img src="/img/influxdb3/cloud-dedicated-admin-ui-create-database.png" alt="Create database dialog" /> 
+6. In the **Create Database** dialog, provide the following information:
+   - **Database name**: The name of the database to create. See [Database naming restrictions](#database-naming-restrictions).
+   - **Retention period**: The retention period for the database. See [Retention period syntax (influxctl CLI)](#retention-period-syntax-influxctl-cli).
+   - **Max tables**: The maximum number of tables (measurements) allowed in the database. Default is 500.
+   - **Max columns per table**: The maximum number of columns allowed in each table (measurement). Default is 250.
+7. Click the **Create Database** button to create the database.
+   The new database displays in the list of databases for the cluster.
+{{% /tab-content %}}
+{{% tab-content %}}
 <!------------------------------- BEGIN INFLUXCTL ----------------------------->
 Use the [`influxctl database create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/)
 to create a database in your {{< product-name omit=" Clustered" >}} cluster.

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

@@ -1,7 +1,7 @@
 ---
 title: Delete a database
 description: >
-  Use the [`influxctl database delete` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete/)
+  Use the Admin UI, the [`influxctl database delete` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete/),
   or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
   to delete a database from your InfluxDB Cloud Dedicated cluster.
   Provide the name of the database you want to delete.
@@ -28,7 +28,7 @@ related:
   - /influxdb3/cloud-dedicated/reference/api/
 ---
 
-Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/)
+Use the Admin UI, the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/),
 or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
 to delete a database from your {{< product-name omit=" Clustered" >}} cluster.
 
@@ -47,10 +47,33 @@ to delete a database from your {{< product-name omit=" Clustered" >}} cluster.
 
 {{< tabs-wrapper >}}
 {{% tabs %}}
+[Admin UI](#)
 [influxctl](#)
 [Management API](#)
 {{% /tabs %}}
 {{% tab-content %}}
+<!------------------------------- BEGIN ADMIN UI ------------------------------>
+The InfluxDB Cloud Dedicated administrative UI includes a portal for
+managing databases.
+
+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).
+3. In the cluster list, find the cluster you want to create a database in. You
+   can sort on column headers or use the **Search** field to find a specific cluster.
+4.  Click the options button (three vertical dots) to the right of the token you want to revoke.
+    The options menu displays.
+5.  In the options menu, click **Delete Database**. The **Delete Database** dialog displays. 
+6.  In the **Delete Database** dialog, check the box to confirm that you "understand the risk of this action".
+7.  Click the **Delete Database** button to delete the database.
+
+{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-delete-database.png" alt="Create database dialog" />}} 
+{{% /tab-content %}}
+{{% tab-content %}}
 
 <!------------------------------- BEGIN INFLUXCTL ----------------------------->
 

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

@@ -1,7 +1,7 @@
 ---
 title: List databases
 description: >
-  Use the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/)
+  Use the Admin UI, the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/), or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
   to list databases in your InfluxDB Cloud Dedicated cluster.
 menu:
   influxdb3_cloud_dedicated:
@@ -25,15 +25,57 @@ related:
   - /influxdb3/cloud-dedicated/reference/api/
 ---
 
-Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/)
-or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster.
+Use the Admin UI, the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/),
+or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to list databases in your {{< product-name omit=" Clustered" >}} cluster.
 
 {{< tabs-wrapper >}}
 {{% tabs %}}
+[Admin UI](#)
 [influxctl](#)
 [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.
+
+The database list displays the following database details:
+
+- Name
+- Database ID
+- Max tables
+- Max columns per table
+- Retention period
+
+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" />}} 
+
+### Database management tools
+
+The options button (3 vertical dots) to the right of any database provides additional tools:
+
+- **Copy Database ID**: Copy the database ID to your clipboard
+- **Set Retention Period**: Set the retention period for the database
+- **Delete Database**: Delete the database
+
+### Manage database tables 
+
+To view database details and manage database tables, click the database row in the list.
+{{% /tab-content %}}
+{{% tab-content %}}
 
 <!------------------------------- BEGIN INFLUXCTL ----------------------------->