Merge 84b196b9ca into 8c6ccfa456
|
|
@ -33,11 +33,28 @@ Your {{% product-name %}} account is a collection of {{% product-name omit="Clus
|
||||||
|
|
||||||
## View account information
|
## View account information
|
||||||
|
|
||||||
After you log in to the Admin UI, the Account Management portal displays the following information about your account:
|
The Admin UI provides access to account information through the **All Accounts** page:
|
||||||
|
|
||||||
- Account ID
|
1. Click the **Account** selector at the bottom of the sidebar navigation
|
||||||
- Contract status
|
2. Select **All Accounts** from the menu
|
||||||
- Contract start date
|
3. View a table with all accounts across your organization
|
||||||
- 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" />}}
|
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-all-accounts.png" alt="InfluxDB Cloud Dedicated Admin UI all accounts view" />}}
|
||||||
|
|
||||||
|
The All Accounts page displays the following information for each account:
|
||||||
|
|
||||||
|
- **Name**: The account name
|
||||||
|
- **Account ID**: Unique identifier for the account
|
||||||
|
- **Status**: Current account status (Active, Cancelled, etc.)
|
||||||
|
- **Type**: Account type
|
||||||
|
- **Created At**: The date the account was created
|
||||||
|
|
||||||
|
Use the search bar to filter accounts by name or ID, and access additional actions through the menu on each row.
|
||||||
|
|
||||||
|
### Switch between accounts
|
||||||
|
|
||||||
|
To switch to a specific account and view its resources:
|
||||||
|
|
||||||
|
1. Click the **Account** selector at the bottom of the sidebar navigation
|
||||||
|
2. Search for or select an account from the list
|
||||||
|
3. The UI updates to show resources (clusters, databases, tokens, users) for the selected account
|
||||||
|
|
|
||||||
|
|
@ -12,89 +12,174 @@ 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.
|
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)
|
- [Access the Admin UI](#access-the-admin-ui)
|
||||||
- [Account management](#account-management)
|
- [Navigate the Admin UI](#navigate-the-admin-ui)
|
||||||
|
- [Account and cluster management](#account-and-cluster-management)
|
||||||
- [Resource management](#resource-management)
|
- [Resource management](#resource-management)
|
||||||
- [Manage clusters](#manage-clusters)
|
- [View cluster overview and metrics](#view-cluster-overview-and-metrics)
|
||||||
- [Manage databases](#manage-databases)
|
- [Manage databases](#manage-databases)
|
||||||
- [Manage tables](#manage-tables)
|
- [Manage tables](#manage-tables)
|
||||||
- [Manage database tokens](#manage-database-tokens)
|
- [Manage database tokens](#manage-database-tokens)
|
||||||
- [Additional Features](#additional-features)
|
- [Manage management tokens](#manage-management-tokens)
|
||||||
|
- [Manage users](#manage-users)
|
||||||
|
- [Get help and support](#get-help-and-support)
|
||||||
|
|
||||||
## Access the Admin UI
|
## 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.
|
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).
|
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.
|
## Navigate the Admin UI
|
||||||
|
|
||||||
## Account management
|
The Admin UI features a collapsible sidebar navigation that provides quick access to all administrative functions:
|
||||||
|
|
||||||
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png" alt="InfluxDB Cloud Dedicated Admin UI account management cluster list" />}}
|
- **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 details and associated clusters
|
## Account and cluster management
|
||||||
- Create, view, and manage management tokens for account-level operations
|
|
||||||
- Access contract information (status, start date)
|
|
||||||
|
|
||||||
For more information, see the following:
|
The Admin UI uses a hierarchical navigation system with account and cluster selection at the bottom of the sidebar:
|
||||||
|
|
||||||
|
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-account-switcher.png" alt="InfluxDB Cloud Dedicated Admin UI account and cluster switcher" />}}
|
||||||
|
|
||||||
|
### 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 across accounts:
|
||||||
|
|
||||||
|
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, see:
|
||||||
- [View account information](/influxdb3/cloud-dedicated/admin/account/)
|
- [View account information](/influxdb3/cloud-dedicated/admin/account/)
|
||||||
- [Manage management tokens](/influxdb3/cloud-dedicated/admin/tokens/)
|
- [Manage clusters](/influxdb3/cloud-dedicated/admin/clusters/)
|
||||||
|
|
||||||
## Resource management
|
## Resource management
|
||||||
|
|
||||||
The Admin UI lets you manage {{% product-name %}} resources, such as databases,
|
The Admin UI lets you manage {{% product-name %}} resources, such as databases, tables, and tokens, associated with a cluster.
|
||||||
tables, and tokens, associated with a cluster.
|
|
||||||
|
|
||||||
- [Manage clusters](#manage-clusters)
|
### View cluster overview and metrics
|
||||||
- [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-overview.png" alt="InfluxDB Cloud Dedicated Admin UI cluster overview" />}}
|
||||||
|
|
||||||
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-clusters-options.png" alt="InfluxDB Cloud Dedicated Admin UI cluster options" />}}
|
The **Overview** page displays real-time cluster information and metrics:
|
||||||
|
|
||||||
- View cluster IDs, statuses, creation date, and sizing information
|
- **Cluster Details**: View cluster name, status, creation date, cluster ID, and cluster URL
|
||||||
- Access Grafana dashboards for operational monitoring (if enabled for the account)
|
- **Cluster Size**: See CPU allocation and component vCPU distribution (Ingest, Compaction, Query, System)
|
||||||
- View and manage resources (such as databases, tables, and database tokens) associated with a cluster
|
- **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
|
||||||
|
|
||||||
For more information, see [Manage clusters](/influxdb3/cloud-dedicated/admin/clusters/).
|
For more information, see [Manage clusters](/influxdb3/cloud-dedicated/admin/clusters/).
|
||||||
|
|
||||||
### Manage databases
|
### Manage databases
|
||||||
|
|
||||||
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-databases.png" alt="InfluxDB Cloud Dedicated Admin UI cluster resources databases list" />}}
|
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-databases.png" alt="InfluxDB Cloud Dedicated Admin UI databases list" />}}
|
||||||
|
|
||||||
|
Use the **Databases** page to manage databases within the selected cluster:
|
||||||
|
|
||||||
- Create and delete databases
|
- Create and delete databases
|
||||||
|
- View database IDs and configuration limits
|
||||||
- Update retention periods
|
- Update retention periods
|
||||||
- Configure maximum tables and columns per table
|
- Configure maximum tables and columns per table
|
||||||
- View and manage tables associated with a database
|
- Navigate to tables associated with a database
|
||||||
|
|
||||||
For more information, see [Manage databases](/influxdb3/cloud-dedicated/admin/databases/).
|
For more information, see [Manage databases](/influxdb3/cloud-dedicated/admin/databases/).
|
||||||
|
|
||||||
### Manage tables
|
### Manage tables
|
||||||
|
|
||||||
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-tables.png" alt="InfluxDB Cloud Dedicated Admin UI database tables list" />}}
|
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-tables.png" alt="InfluxDB Cloud Dedicated Admin UI tables list" />}}
|
||||||
|
|
||||||
- View tables associated with databases
|
Use the **Tables** page to manage tables within databases:
|
||||||
- See table IDs and sizes
|
|
||||||
|
- Select a database from the dropdown to view its tables
|
||||||
|
- View table IDs and sizes
|
||||||
|
- See database size summary
|
||||||
- Create new tables
|
- Create new tables
|
||||||
|
- Access detailed table schema information
|
||||||
|
|
||||||
For more information, see [Manage tables](/influxdb3/cloud-dedicated/admin/tables/).
|
For more information, see [Manage tables](/influxdb3/cloud-dedicated/admin/tables/).
|
||||||
|
|
||||||
### Manage database tokens
|
### 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" />}}
|
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-database-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI database tokens" />}}
|
||||||
|
|
||||||
- Create and manage authentication tokens for database-level operations
|
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
|
- Edit permissions or revoke existing tokens
|
||||||
- Control access with granular read and write permissions
|
- Control access with read and write permissions for specific databases
|
||||||
|
- Toggle display of inactive tokens
|
||||||
|
|
||||||
For more information, see [Manage database tokens](/influxdb3/cloud-dedicated/admin/tokens/).
|
For more information, see [Manage database tokens](/influxdb3/cloud-dedicated/admin/tokens/).
|
||||||
|
|
||||||
### Additional Features
|
### Manage management tokens
|
||||||
|
|
||||||
- Help center for access to documentation
|
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-management-tokens.png" alt="InfluxDB Cloud Dedicated Admin UI management tokens" />}}
|
||||||
- One-click connections to InfluxData sales and support
|
|
||||||
|
Use the **Management Tokens** page to manage tokens for account-level administrative operations:
|
||||||
|
|
||||||
|
- 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.
|
||||||
|
|
||||||
|
For more information, see [Manage management tokens](/influxdb3/cloud-dedicated/admin/tokens/).
|
||||||
|
|
||||||
|
### Manage users
|
||||||
|
|
||||||
|
{{< img-hd src="/img/influxdb3/cloud-dedicated-admin-ui-users.png" alt="InfluxDB Cloud Dedicated Admin UI users" />}}
|
||||||
|
|
||||||
|
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
|
||||||
|
|
||||||
|
For more information, see [Manage users](/influxdb3/cloud-dedicated/admin/users/).
|
||||||
|
|
||||||
|
## 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.
|
||||||
|
|
|
||||||
|
Before Width: | Height: | Size: 1.1 MiB |
|
After Width: | Height: | Size: 682 KiB |
|
After Width: | Height: | Size: 431 KiB |
|
After Width: | Height: | Size: 302 KiB |
|
Before Width: | Height: | Size: 510 KiB |
|
Before Width: | Height: | Size: 572 KiB After Width: | Height: | Size: 510 KiB |
|
Before Width: | Height: | Size: 554 KiB After Width: | Height: | Size: 362 KiB |
|
After Width: | Height: | Size: 452 KiB |
|
Before Width: | Height: | Size: 96 KiB After Width: | Height: | Size: 92 KiB |
|
After Width: | Height: | Size: 516 KiB |
|
After Width: | Height: | Size: 660 KiB |
|
Before Width: | Height: | Size: 458 KiB After Width: | Height: | Size: 266 KiB |
|
After Width: | Height: | Size: 407 KiB |