diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index 1132ae5cf..505688122 100644 --- a/.github/copilot-instructions.md +++ b/.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 >}}` diff --git a/content/influxdb3/cloud-dedicated/admin/account/_index.md b/content/influxdb3/cloud-dedicated/admin/account/_index.md new file mode 100644 index 000000000..852e78438 --- /dev/null +++ b/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: + +
+   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). + +## 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" />}} diff --git a/content/influxdb3/cloud-dedicated/admin/clusters/get.md b/content/influxdb3/cloud-dedicated/admin/clusters/get.md index f75415775..1e8fcec38 100644 --- a/content/influxdb3/cloud-dedicated/admin/clusters/get.md +++ b/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 ` 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: + +
+   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. + +### 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 >}} diff --git a/content/influxdb3/cloud-dedicated/admin/clusters/list.md b/content/influxdb3/cloud-dedicated/admin/clusters/list.md index ccf9c2e7f..42f560d99 100644 --- a/content/influxdb3/cloud-dedicated/admin/clusters/list.md +++ b/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: + +
+   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. + +### 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 >}} + diff --git a/content/influxdb3/cloud-dedicated/admin/databases/create.md b/content/influxdb3/cloud-dedicated/admin/databases/create.md index b6a3df965..8f6b66334 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/create.md +++ b/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 %}} + +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: + +
+   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). +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. + + 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 %}} 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. diff --git a/content/influxdb3/cloud-dedicated/admin/databases/delete.md b/content/influxdb3/cloud-dedicated/admin/databases/delete.md index 0903085f2..fa59968db 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/delete.md +++ b/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 %}} + +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: + +
+   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). +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 %}} diff --git a/content/influxdb3/cloud-dedicated/admin/databases/list.md b/content/influxdb3/cloud-dedicated/admin/databases/list.md index ad3b34b5e..b696c7a0c 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/list.md +++ b/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: + +
+   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. + +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 %}} diff --git a/content/influxdb3/cloud-dedicated/admin/databases/update.md b/content/influxdb3/cloud-dedicated/admin/databases/update.md index f8fc40fff..de250dc3e 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/update.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/update.md @@ -1,7 +1,7 @@ --- title: Update a database description: > - Use the [`influxctl database update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/) + Use the Admin UI, the [`influxctl database update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/), or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to update attributes for a database in your InfluxDB Cloud Dedicated cluster. Provide the database name and the attributes to update. @@ -38,15 +38,37 @@ related: - /influxdb3/cloud-dedicated/reference/api/ --- -Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/) +Use the Admin UI, the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create/), or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to update attributes such as retention period, column limits, and table limits for a database in your {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} {{% tabs %}} +[Admin UI](#) [influxctl](#) [Management API](#) {{% /tabs %}} {{% tab-content %}} + +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: + +
+   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. Click a cluster row to view the list of databases associated with the cluster. 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. Find the database you want to update. + 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. +5. To set the retention period, click the options button (3 vertical dots) to the right of the database. +6. In the options menu, click **Set Retention Period**. +{{% /tab-content %}} +{{% tab-content %}} Use the [`influxctl database update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/) diff --git a/content/influxdb3/cloud-dedicated/admin/tables/create.md b/content/influxdb3/cloud-dedicated/admin/tables/create.md index 4a5ec8784..120ec35ca 100644 --- a/content/influxdb3/cloud-dedicated/admin/tables/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/create.md @@ -1,7 +1,7 @@ --- title: Create a table description: > - Use the [`influxctl table create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create/) + Use the Admin UI or the [`influxctl table create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create/) to create a new table in a specified database your InfluxDB cluster. Provide the database name and a table name. menu: @@ -17,7 +17,7 @@ related: - /influxdb3/cloud-dedicated/admin/custom-partitions/ --- -Use the [`influxctl table create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create/) +Use the Admin UI or the [`influxctl table create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create/) to create a table in a specified database in your {{< product-name omit=" Clustered" >}} cluster. diff --git a/content/influxdb3/cloud-dedicated/admin/tables/list.md b/content/influxdb3/cloud-dedicated/admin/tables/list.md index 73737fe93..5533845e0 100644 --- a/content/influxdb3/cloud-dedicated/admin/tables/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/list.md @@ -1,7 +1,7 @@ --- title: List tables description: > - Use the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/explore-schema/#list-measurements-in-a-database) + Use the Admin UI, the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/explore-schema/#list-measurements-in-a-database), or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database) to list tables in a database. menu: @@ -25,13 +25,53 @@ related: - /influxdb3/cloud-dedicated/query-data/influxql/explore-schema/ --- -Use the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/explore-schema/#list-measurements-in-a-database) +Use the Admin UI, the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/explore-schema/#list-measurements-in-a-database), or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database) to list tables in a database. > [!Note] > With {{< product-name >}}, tables and measurements are synonymous. +{{< tabs-wrapper >}} +{{% tabs %}} +[Admin UI](#admin-ui) +[influxctl](#influxctl) +{{% /tabs %}} +{{% tab-content %}} + +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: + +- Name +- Table ID +- Table size (in bytes) + +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. 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. + +{{% /tab-content %}} +{{% tab-content %}} + ###### SQL ```sql @@ -78,3 +118,5 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Name of the database to query +{{% /tab-content %}} +{{< /tabs-wrapper >}} \ No newline at end of file diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/_index.md b/content/influxdb3/cloud-dedicated/admin/tokens/_index.md index 3381e2412..994f5eaa4 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/_index.md @@ -16,34 +16,5 @@ aliases: InfluxDB uses token authentication to authorize access to data in your {{< product-name omit=" Clustered" >}} cluster. -There are two types of tokens: - -- [Database tokens](#database-tokens) -- [Management tokens](#management-tokens) - -#### Database tokens - -Database tokens grant read and write permissions to one or more databases -and allows for actions like writing and querying data. - -All read and write actions performed against time series data in your -{{< product-name omit=" Clustered" >}} cluster must be authorized using a database token. - -#### Management tokens - -Management tokens grant permission to perform administrative actions such as -managing users, databases, and database tokens. -Management tokens allow clients, such as the -[`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/), -to perform administrative actions. - -> [!Note] -> #### Store secure tokens in a secret store -> -> Token strings are returned _only_ on token creation. -> We recommend storing database tokens in a **secure secret store**. -> For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os). - ---- {{< children hlevel="h2" readmore=true hr=true >}} diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md index 5148268ec..ea40d4768 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md @@ -1,7 +1,7 @@ --- title: Create a database token description: > - Use the [`influxctl token create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) + Use the Admin UI, the [`influxctl token create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/), or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) for reading and writing data in your InfluxDB Cloud Dedicated cluster. Provide a token description and permissions for databases. @@ -52,16 +52,49 @@ 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 token](/influxdb3/cloud-dedicated/admin/tokens/database/) with permissions for reading and writing data in your {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} {{% tabs %}} +[Admin UI](#) [influxctl](#) [Management API](#) {{% /tabs %}} {{% tab-content %}} + +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 >}}
+    
+ +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. + The **Create Database Token** dialog displays. + + {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-create-database-token.png" alt="Create database token dialog" />}} + +8. Add a token description. + The description is used to identify the token in the list of tokens. +9. To create a token that expires, enable the **Expiration** toggle, + and then select the expiration date and time. +10. Set the token permissions: + - Select the database or **All Databases** for the permission + - Use the **Read** and **Write** buttons under **Actions** to toggle these permissions on or off for the selected database. +11. Click the **Create Token** button. The dialog displays the **Token secret** string and the description you provided. + +{{% /tab-content %}} +{{% tab-content %}} Use the [`influxctl token create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md index 832867852..a67f7f268 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/list.md @@ -1,7 +1,7 @@ --- title: List database tokens description: > - Use the [`influxctl token list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list/) + Use the Admin UI, the [`influxctl token list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list/), or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to list database tokens in your InfluxDB Cloud Dedicated cluster. menu: @@ -35,7 +35,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 list database tokens in your {{< product-name omit=" Clustered" >}} cluster. @@ -46,10 +46,49 @@ to list database tokens in your {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} {{% tabs %}} +[Admin UI](#admin-ui-list-tokens) [influxctl](#) [Management API](#) {{% /tabs %}} {{% tab-content %}} + + +The InfluxDB Cloud Dedicated administrative UI includes a portal for creating and managing database tokens. + +Administrators can use this portal to: + +- View token details +- Add read and write permissions for specific databases to a token +- Edit a token's existing read and write permissions for a database +- 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. + +The Database Tokens portal lists all database tokens associated with the cluster +and provides the following information about each token: + +- Token ID +- Description +- Databases +- Status (Active or Revoked) +- Created At date +- Expires At 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. +{{% /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 an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster.2. In your terminal, run the `influxctl token list` command and provide the following: diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md index 33c30cb85..df870c745 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md @@ -1,9 +1,9 @@ --- title: Revoke a database token description: > - Use the [`influxctl token revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/revoke/) + Use the Admin UI, the [`influxctl token revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/revoke/), or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) - to revoke a database token associated with your {{% product-name omit-" Clustered" %}} + to revoke a database token associated with your {{% product-name omit=" Clustered" %}} cluster and remove all permissions associated with the token. Provide the ID of the database token you want to revoke. menu: @@ -39,10 +39,48 @@ to revoke a database token associated with your {{< tabs-wrapper >}} {{% tabs %}} +[Admin UI](#) [influxctl](#) [Management API](#) {{% /tabs %}} {{% tab-content %}} + +The InfluxDB Cloud Dedicated administrative UI includes a portal for creating +and managing database tokens. + +Administrators can use this portal to: + +- View token details +- Add read and write permissions for specific databases to a token +- Edit a token's existing read and write permissions for a database +- 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. + 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**. + The **Revoke Database Token** dialog displays. + + {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-revoke-database-token.png" alt="Revoke database token dialog" />}} + +9. Check the box to confirm that you understand the risk. +10. Click the **Revoke Token** button. + The token is revoked and filtered from the list of active tokens. +{{% /tab-content %}} +{{% tab-content %}} Use the [`influxctl token revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/revoke/) diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md index e4f968056..c43861077 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md @@ -1,9 +1,9 @@ --- title: Update a database token description: > - Use the [`influxctl token update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/) + Use the Admin UI, the [`influxctl token update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/), or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) - to update a database token's permissions in your InfluxDB Cloud Dedicated cluster. + to update a database token's permissions in your {{< product-name omit=" Clustered" >}} cluster. menu: influxdb3_cloud_dedicated: parent: Database tokens @@ -52,17 +52,74 @@ 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 update a database token's permissions {{< product-name omit=" Clustered" >}} cluster. {{< tabs-wrapper >}} {{% tabs %}} +[Admin UI](#) [influxctl](#) [Management API](#) {{% /tabs %}} {{% tab-content %}} + +The InfluxDB Cloud Dedicated administrative UI includes a portal for creating +and managing database tokens. +Through this portal, administrators can edit a token's permissions to: + +- Add read and write permissions for specific databases +- Edit a token's existing read and write permissions for a database + +### Open the Edit Database Token dialog + +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. + 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. + 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. + + {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-database-token-options-menu.png" alt="Database token option menu" />}} + +8. Click **Edit Token** in the dropdown menu. The **Edit Database Token** dialog displays. + + {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-edit-database-token.png" alt="Edit Database Token dialog" />}} + +9. In the **Edit Database Token** dialog, you can edit the token's **Description** and permissions. + +### Edit token permissions + +1. [Open the Edit Database Token dialog](#open-the-edit-database-token-dialog) for the database token. + + The **Edit Database Token** dialog displays the token's existing permissions. + Each permission consists of: + + - A database (specific database name or **All Databases**) + - Action permissions (Read and Write) + +2. To change which database a permission applies to, click the **Database** dropdown and select a different database or **All Databases**. +3. To adjust the access level of the permission, use the **Read** and **Write** buttons under **Actions** to toggle these permissions on or off for the selected database. + +### Add token permissions + +1. [Open the Edit Database Token dialog](#open-the-edit-database-token-dialog) for the database token. +2. In the dialog, click **Add Permission**. +3. For the new permission, select a database from the dropdown. +4. Toggle the **Read** and **Write** buttons to set the access level. +{{% /tab-content %}} +{{% tab-content %}} Use the [`influxctl token update` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/) to update a database token's permissions in your {{< product-name omit=" Clustered" >}} cluster. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md index 27ae83db6..7c0de3fe2 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md @@ -1,7 +1,7 @@ --- title: Create a management token description: > - Use the [`influxctl management create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create) + Use the Admin UI or the [`influxctl management create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create) to manually create a management token. menu: influxdb3_cloud_dedicated: @@ -18,6 +18,8 @@ list_code_example: | --description "Example token description" ``` --- +Use the Admin UI or the [`influxctl management create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create) +to manually create a management token. By default, management tokens are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your @@ -37,6 +39,40 @@ interaction with your identity provider. > and authorized through your OAuth2 identity provider to manually create a > management token. +{{< tabs-wrapper >}} +{{% tabs %}} +[Admin UI](#admin-ui) +[influxctl](#influxctl) +{{% /tabs %}} +{{% tab-content %}} + +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: + +
+   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). +3. Click the **Management Tokens** button in the upper right corner of the Account Management portal. +4. In the Management Tokens portal, click the **New Management Token** button. + The **Create Management Token** dialog displays. + + {{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-create-management-token.png" alt="Create management token dialog" />}} + +5. You can optionally set the following fields: + - **Expiration date**: Set an expiration date for the token + - **Expiration time**: Set an expiration time for the token + - **Description**: Enter a description for the token + - + If an expiration isn't set, the token does not expire until revoked. +6. Click the **Create Token** button. The dialog displays the **Token secret** string and the description you provided. +{{% /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). 2. Use the [`influxctl management create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create/) to manually create a management token. Provide the following: @@ -61,6 +97,8 @@ Replace the following: `{{< datetime/current-date offset=1 >}}`. - {{% code-placeholder-key %}}`TOKEN_DESCRIPTION`{{% /code-placeholder-key %}}: Management token description. +{{% /tab-content %}} +{{< /tabs-wrapper >}} Once created, the command returns the management token string. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md index b568e2c1f..a63ff2efd 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md @@ -1,7 +1,7 @@ --- title: List management tokens description: > - Use the [`influxctl management list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list/) + Use the Admin UI or the [`influxctl management list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list/) to list manually-created management tokens. menu: influxdb3_cloud_dedicated: @@ -17,9 +17,44 @@ list_code_example: | ``` --- -Use the [`influxctl management list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list) +Use the Admin UI or the [`influxctl management list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list) to list manually-created management tokens. +{{< tabs-wrapper >}} +{{% tabs %}} +[Admin UI](#admin-ui) +[influxctl](#influxctl) +{{% /tabs %}} +{{% tab-content %}} + +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: + +
+   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). + +3. To list management tokens, click the **Management Tokens** button in the upper right corner of the Account Management portal. + +The Management Tokens portal displays the following information about each token: + +- Status +- Description +- Token ID +- 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. + +{{% /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). 2. Run `influxctl management list` with the following: @@ -40,6 +75,8 @@ influxctl management list --format json > Revoked tokens still appear when listing management tokens, but they are no > longer valid for any operations. +{{% /tab-content %}} +{{< /tabs-wrapper >}} ### Output formats The `influxctl management list` command supports two output formats: `table` and `json`. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md index 3886fbf52..8c17f6758 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md @@ -1,7 +1,7 @@ --- title: Revoke a management token description: > - Use the [`influxctl management revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke/) + Use the Admin UI or the [`influxctl management revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke/) to revoke a management token and remove all access associated with the token. Provide the ID of the management token you want to revoke. menu: @@ -16,9 +16,35 @@ list_code_example: | ``` --- -Use the [`influxctl management revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke/) +Use the Admin UI or the [`influxctl management revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke/) to revoke a management token and remove all access associated with the token. +{{< tabs-wrapper >}} +{{% tabs %}} +[Admin UI](#admin-ui) +[influxctl](#influxctl) +{{% /tabs %}} +{{% tab-content %}} + +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: + +
+    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. +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**. +7. In the **Revoke Management Token** dialog, check the box to confirm you "Understand the risk of this action". +8. Click the **Revoke Token** button to revoke the token. + The token is revoked and filtered from the list of active tokens. +{{% /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). 2. Run the [`influxctl management list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list) to output tokens with their IDs. @@ -43,6 +69,8 @@ influxctl management revoke --force TOKEN_ID Replace {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}} with the ID of the token you want to revoke. +{{% /tab-content %}} +{{% /tabs-wrapper %}} > [!Note] > #### Revoked tokens are included when listing management tokens diff --git a/content/influxdb3/cloud-dedicated/reference/admin-ui.md b/content/influxdb3/cloud-dedicated/reference/admin-ui.md new file mode 100644 index 000000000..ca143ff4a --- /dev/null +++ b/content/influxdb3/cloud-dedicated/reference/admin-ui.md @@ -0,0 +1,100 @@ +--- +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: 6 +--- + +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/cloud-dedicated/reference/cli/_index.md b/content/influxdb3/cloud-dedicated/reference/cli/_index.md index 85d870138..7287515b2 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/_index.md @@ -10,10 +10,11 @@ menu: parent: Reference name: CLIs weight: 104 +draft: true --- -InfluxDB provides command line tools designed to manage and work with your -InfluxDB Cloud Dedicated cluster from the command line. + + The following command line interfaces (CLIs) are available: {{< children >}} diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/_index.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/_index.md index 5c29cbc7a..7dd0ced1c 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/_index.md @@ -9,12 +9,16 @@ menu: name: influxctl parent: CLIs weight: 101 +aliases: + - /influxdb3/cloud-dedicated/reference/cli/ influxdb3/cloud-dedicated/tags: [cli] --- The `influxctl` command line interface (CLI) writes to, queries, and performs -administrative tasks in an {{< product-name omit=" Clustered" >}} cluster. +administrative tasks in an {{< product-name omit=" Clustered" >}} cluster and +provides a scriptable way to manage your {{% product-name %}} resources. +- [Key features](#key-features) - [Usage](#usage) - [Commands](#commands) - [Global flags](#global-flags) @@ -22,6 +26,12 @@ administrative tasks in an {{< product-name omit=" Clustered" >}} cluster. - [Configure connection profiles](#configure-connection-profiles) - [Authentication](#authentication) +## Key features + +- Authentication via environment variables or config file +- JSON output for scripting and automation +- Can be integrated into CI/CD pipelines + ## Usage ```sh diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/create.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/create.md index 217931389..e6e776475 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/create.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/create.md @@ -9,42 +9,4 @@ weight: 301 draft: true --- -The `influxctl cluster create` command creates an {{% product-name omit=" Clustered" %}} cluster. - -## Usage - -```sh -influxctl cluster create [flags] -``` - -## Flags - -| Flag | | Description | -| :--- | ------------------------- | :-------------------------------------------------------------------------------------------- | -| | `--region` | {{< req >}}: Region to create cluster in | -| | `--category` | {{< req >}}: Cluster category (`contract`, `internal`, `unpaid_poc`, `paid_poc`, or `system`) | -| | `--ingestor-units` | Ingestor units _(default is 0)_ | -| | `--ingestor-granularity` | Ingestor granularity _(default is 0)_ | -| | `--compactor-units` | Compactor units _(default is 0)_ | -| | `--compactor-granularity` | Compactor granularity _(default is 0)_ | -| | `--query-units` | Query units _(default is 0)_ | -| | `--query-granularity` | Query granularity _(default is 0)_ | -| `-h` | `--help` | Output command help | - -{{% caption %}} -_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._ -{{% /caption %}} - -## Examples - -##### Create an InfluxDB Cloud Dedicated cluster - -```sh -influxctl cluster create \ - --region us-west-2 \ - --category internal \ - --ingestor-units 3 \ - --compactor-units 1 \ - --query-units 1 \ - example-cluster-name -``` + diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/update.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/update.md index 59ea3f7df..6d282b5e0 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/update.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/update.md @@ -9,47 +9,4 @@ weight: 301 draft: true --- -The `influxctl cluster update` command updates an {{% product-name omit=" Clustered" %}} cluster. - -## Usage - -```sh -influxctl cluster update [flags] -``` - -## Arguments - -| Argument | Description | -| :------------- | :----------------------- | -| **CLUSTER_ID** | ID of the [cluster](/influxdb3/cloud-dedicated/reference/glossary/#cluster) to get | - -## Flags - -| Flag | | Description | -| :--- | ------------------------- | :-------------------------------------------------------------------------------------------- | -| | `--state` | {{< req >}}: Cluster state (`ready` or `deleted`) | -| | `--category` | {{< req >}}: Cluster category (`contract`, `internal`, `unpaid_poc`, `paid_poc`, or `system`) | -| | `--ingestor-units` | Ingestor units _(default is 0)_ | -| | `--ingestor-granularity` | Ingestor granularity _(default is 0)_ | -| | `--compactor-units` | Compactor units _(default is 0)_ | -| | `--compactor-granularity` | Compactor granularity _(default is 0)_ | -| | `--query-units` | Query units _(default is 0)_ | -| | `--query-granularity` | Query granularity _(default is 0)_ | -| `-h` | `--help` | Output command help | - -{{% caption %}} -_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._ -{{% /caption %}} - -## Examples - -##### Update an InfluxDB Cloud Dedicated cluster - -```sh -influxctl cluster update \ - --state ready \ - --category contract \ - --ingestor-units 3 \ - --compactor-units 1 \ - --query-units 1 \ -``` + \ No newline at end of file diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-account-info.png b/static/img/influxdb3/cloud-dedicated-admin-ui-account-info.png new file mode 100644 index 000000000..083063c90 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-account-info.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 new file mode 100644 index 000000000..d63dc816e Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-create-database-token.png b/static/img/influxdb3/cloud-dedicated-admin-ui-create-database-token.png new file mode 100644 index 000000000..0196eccc0 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-create-database-token.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-create-database.png b/static/img/influxdb3/cloud-dedicated-admin-ui-create-database.png new file mode 100644 index 000000000..8dcf698d1 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-create-database.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-create-management-token.png b/static/img/influxdb3/cloud-dedicated-admin-ui-create-management-token.png new file mode 100644 index 000000000..f36bd5365 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-create-management-token.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-create-table.png b/static/img/influxdb3/cloud-dedicated-admin-ui-create-table.png new file mode 100644 index 000000000..638d5a864 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-create-table.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-database-token-options-menu.png b/static/img/influxdb3/cloud-dedicated-admin-ui-database-token-options-menu.png new file mode 100644 index 000000000..daeef3bc8 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-database-token-options-menu.png 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 new file mode 100644 index 000000000..ab562b04a Binary files /dev/null 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 new file mode 100644 index 000000000..971c4bb43 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-databases.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-delete-database.png b/static/img/influxdb3/cloud-dedicated-admin-ui-delete-database.png new file mode 100644 index 000000000..f16e0e4d1 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-delete-database.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-edit-database-token.png b/static/img/influxdb3/cloud-dedicated-admin-ui-edit-database-token.png new file mode 100644 index 000000000..87bb83e2c Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-edit-database-token.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 new file mode 100644 index 000000000..79024ee70 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-list-databases.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-login.png b/static/img/influxdb3/cloud-dedicated-admin-ui-login.png new file mode 100644 index 000000000..f276e3654 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-login.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-management-tokens-portal.png b/static/img/influxdb3/cloud-dedicated-admin-ui-management-tokens-portal.png new file mode 100644 index 000000000..2e4b2f5f3 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-management-tokens-portal.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 000000000..98fc1df9a 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-revoke-database-token.png b/static/img/influxdb3/cloud-dedicated-admin-ui-revoke-database-token.png new file mode 100644 index 000000000..2472d5332 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-revoke-database-token.png differ diff --git a/static/img/influxdb3/cloud-dedicated-admin-ui-tables.png b/static/img/influxdb3/cloud-dedicated-admin-ui-tables.png new file mode 100644 index 000000000..da6714813 Binary files /dev/null and b/static/img/influxdb3/cloud-dedicated-admin-ui-tables.png differ