diff --git a/src/current/_data/redirects.yml b/src/current/_data/redirects.yml index 112a27d82d7..9f77fc9de72 100644 --- a/src/current/_data/redirects.yml +++ b/src/current/_data/redirects.yml @@ -1120,4 +1120,7 @@ - destination: reads-and-writes-overview.md sources: ['query-data.md'] - versions: ['v26.1', 'v26.2'] \ No newline at end of file + versions: ['v26.1', 'v26.2'] + +- destination: cockroachcloud/overview-page.md + sources: ['cockroachcloud/cluster-overview-page.md'] \ No newline at end of file diff --git a/src/current/_includes/cockroachcloud/request-units.md b/src/current/_includes/cockroachcloud/request-units.md index b0f03b6468f..2586fc64df5 100644 --- a/src/current/_includes/cockroachcloud/request-units.md +++ b/src/current/_includes/cockroachcloud/request-units.md @@ -1 +1 @@ -All cluster activity, including SQL queries, bulk operations, and background jobs, is measured in Request Units, or RUs. An RU is an abstracted metric that represents the [compute and I/O resources]({% link cockroachcloud/resource-usage.md %}#understand-resource-consumption) used by a database operation. In addition to queries that you run, background activity, such as automatic statistics to optimize your queries or running a changefeed to an external sink, also consumes RUs. You can review how many request units your cluster has used on the [Cluster Overview]({% link cockroachcloud/cluster-overview-page.md %}#request-units) page. \ No newline at end of file +All cluster activity, including SQL queries, bulk operations, and background jobs, is measured in Request Units, or RUs. An RU is an abstracted metric that represents the [compute and I/O resources]({% link cockroachcloud/resource-usage.md %}#understand-resource-consumption) used by a database operation. In addition to queries that you run, background activity, such as automatic statistics to optimize your queries or running a changefeed to an external sink, also consumes RUs. You can review how many request units your cluster has used on the [Overview]({% link cockroachcloud/overview-page.md %}#request-units) page. \ No newline at end of file diff --git a/src/current/_includes/sidebar-data-cockroachcloud.json b/src/current/_includes/sidebar-data-cockroachcloud.json index b5550f324b7..1099c5f9e45 100644 --- a/src/current/_includes/sidebar-data-cockroachcloud.json +++ b/src/current/_includes/sidebar-data-cockroachcloud.json @@ -190,9 +190,9 @@ "title": "Monitor Your Cluster", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v23.1/sidebar-data/cloud-deployments.json b/src/current/_includes/v23.1/sidebar-data/cloud-deployments.json index 48c5b4e8bcf..9c270cb1f0a 100644 --- a/src/current/_includes/v23.1/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v23.1/sidebar-data/cloud-deployments.json @@ -344,9 +344,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v23.2/sidebar-data/cloud-deployments.json b/src/current/_includes/v23.2/sidebar-data/cloud-deployments.json index 64445a40a15..f31ba9d168c 100644 --- a/src/current/_includes/v23.2/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v23.2/sidebar-data/cloud-deployments.json @@ -344,9 +344,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v24.1/sidebar-data/cloud-deployments.json b/src/current/_includes/v24.1/sidebar-data/cloud-deployments.json index 9966d29d608..c22afbfa933 100644 --- a/src/current/_includes/v24.1/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v24.1/sidebar-data/cloud-deployments.json @@ -344,9 +344,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v24.2/sidebar-data/cloud-deployments.json b/src/current/_includes/v24.2/sidebar-data/cloud-deployments.json index 4ee6a8fd60a..d79079574d5 100644 --- a/src/current/_includes/v24.2/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v24.2/sidebar-data/cloud-deployments.json @@ -380,9 +380,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v24.3/sidebar-data/cloud-deployments.json b/src/current/_includes/v24.3/sidebar-data/cloud-deployments.json index e950f73f63e..e6a792a86e3 100644 --- a/src/current/_includes/v24.3/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v24.3/sidebar-data/cloud-deployments.json @@ -380,9 +380,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v25.1/sidebar-data/cloud-deployments.json b/src/current/_includes/v25.1/sidebar-data/cloud-deployments.json index e5478d650a0..6d54ae76934 100644 --- a/src/current/_includes/v25.1/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v25.1/sidebar-data/cloud-deployments.json @@ -391,9 +391,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v25.2/sidebar-data/cloud-deployments.json b/src/current/_includes/v25.2/sidebar-data/cloud-deployments.json index 5636e591a8d..2d206322551 100644 --- a/src/current/_includes/v25.2/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v25.2/sidebar-data/cloud-deployments.json @@ -386,9 +386,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v25.3/sidebar-data/cloud-deployments.json b/src/current/_includes/v25.3/sidebar-data/cloud-deployments.json index 88a04d9d0c2..cc6da870650 100644 --- a/src/current/_includes/v25.3/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v25.3/sidebar-data/cloud-deployments.json @@ -391,9 +391,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v25.4/sidebar-data/cloud-deployments.json b/src/current/_includes/v25.4/sidebar-data/cloud-deployments.json index 88a04d9d0c2..cc6da870650 100644 --- a/src/current/_includes/v25.4/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v25.4/sidebar-data/cloud-deployments.json @@ -391,9 +391,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v26.1/sidebar-data/cloud-deployments.json b/src/current/_includes/v26.1/sidebar-data/cloud-deployments.json index c116fa07ea6..3114b07c714 100644 --- a/src/current/_includes/v26.1/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v26.1/sidebar-data/cloud-deployments.json @@ -380,9 +380,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/_includes/v26.2/sidebar-data/cloud-deployments.json b/src/current/_includes/v26.2/sidebar-data/cloud-deployments.json index f208ebda3b2..6ae5a968ddd 100644 --- a/src/current/_includes/v26.2/sidebar-data/cloud-deployments.json +++ b/src/current/_includes/v26.2/sidebar-data/cloud-deployments.json @@ -380,9 +380,9 @@ "title": "Monitoring and Alerting", "items": [ { - "title": "Cluster Overview Page", + "title": "Overview Page", "urls": [ - "/cockroachcloud/cluster-overview-page.html" + "/cockroachcloud/overview-page.html" ] }, { diff --git a/src/current/cockroachcloud/advanced-cluster-management.md b/src/current/cockroachcloud/advanced-cluster-management.md index 2816cf4fde8..bf5869d97b7 100644 --- a/src/current/cockroachcloud/advanced-cluster-management.md +++ b/src/current/cockroachcloud/advanced-cluster-management.md @@ -25,9 +25,9 @@ To view and manage a specific cluster, click the name of the cluster. The [**Ove ## View cluster overview -The [**Overview** page]({% link cockroachcloud/cluster-overview-page.md %}) displays details about the selected CockroachDB {{ site.data.products.cloud }} cluster. +The [**Overview** page]({% link cockroachcloud/overview-page.md %}) displays details about the selected CockroachDB {{ site.data.products.cloud }} cluster. -From the **Overview** page, you can connect to your cluster. For more information, see [Connect to Your CockroachDB {{ site.data.products.advanced }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}). +Click the **Connect** button to get client connection details for your cluster. For more information, see [Connect to Your CockroachDB {{ site.data.products.advanced }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}). ## Edit labels @@ -52,7 +52,7 @@ You cannot scale a multi-node cluster down to a single-node cluster. To add or remove nodes from your cluster: 1. Navigate to the cluster's **Overview** page. -1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**. +1. Click on **Configuration** to expand the **Cluster configuration** section, then click on **Edit** next to the cluster's **Regions**. The **Edit cluster** page displays. @@ -62,10 +62,11 @@ To add or remove nodes from your cluster: ### Change compute for a cluster -1. Navigate to the cluster's **Overview** page and click **Update capacity**. +1. Click on the three-dots menu and select **Edit cluster**. The **Edit cluster** page displays. +1. Click on **Next: Capacity** to open the **Capacity** page. 1. In the **Compute per node** section, select the new amount of vCPUs per node. {{site.data.alerts.callout_info}} @@ -81,8 +82,7 @@ To add or remove nodes from your cluster: AWS disks can only be scaled once every six hours. {{site.data.alerts.end}} -1. Navigate to the cluster's **Overview** page. -1. Select **Actions > Edit cluster**. +1. Click on the three-dots menu and select **Edit cluster**. The **Edit cluster** page displays. @@ -103,8 +103,7 @@ You can add or remove up to nine regions at a time through the Console. Note tha You can add up to nine regions at a time through the Console. See [Planning your cluster]({% link cockroachcloud/plan-your-cluster.md %}) for cluster requirements and recommendations before proceeding. -1. Navigate to the cluster's **Overview** page. -1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**. +1. Click on the three-dots menu and select **Edit cluster**. The **Edit cluster** page displays. @@ -126,8 +125,7 @@ If your [zone configurations]({% link {{site.current_cloud_version}}/configure-r To remove a region from your cluster: -1. Navigate to the cluster's **Overview** page. -1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**. +1. Click on the three-dots menu and select **Edit cluster**. The **Edit cluster** page displays. @@ -142,7 +140,7 @@ To remove a region from your cluster: ## Set a maintenance window -From your cluster's [**Overview** page]({% link cockroachcloud/cluster-overview-page.md %}), you can view and manage the maintenance and [patch upgrade]({% link cockroachcloud/upgrade-policy.md %}#patch-version-upgrades) window for your cluster. During the window, your cluster may experience restarts, degraded performance, and downtime for single-node clusters. To help keep your clusters updated while minimizing disruptions, set a window of time when your cluster is experiencing the lowest traffic. If no maintenance window is set, your cluster will be automatically upgraded as soon as new patch versions are available, and other cluster maintenance occurs as needed. Refer to [CockroachDB Cloud Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}). +From your cluster's [**Overview** page]({% link cockroachcloud/overview-page.md %}), you can view and manage the maintenance and [patch upgrade]({% link cockroachcloud/upgrade-policy.md %}#patch-version-upgrades) window for your cluster. During the window, your cluster may experience restarts, degraded performance, and downtime for single-node clusters. To help keep your clusters updated while minimizing disruptions, set a window of time when your cluster is experiencing the lowest traffic. If no maintenance window is set, your cluster will be automatically upgraded as soon as new patch versions are available, and other cluster maintenance occurs as needed. Refer to [CockroachDB Cloud Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}). Setting maintenance windows requires the [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) or [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) role. @@ -152,7 +150,8 @@ Maintenance operations that are critical for cluster security or stability may b To set a maintenance window in the {{ site.data.products.cloud }} console: -1. Click the pencil icon next to **Cluster maintenance** to edit the maintenance window. +1. On the **Overview** page, click **Settings** to open the **Cluster settings** panel. +1. Click the **Edit** button next to **Maintenance window**. 1. From the **Day** dropdown, select the day of the week during which maintenance may be applied. 1. From the **Start of window** dropdown, select a start time for your maintenance window in UTC. @@ -176,7 +175,7 @@ All databases are not backed up at the same time. Each database is backed up eve ## Configure PCI ready features -CockroachDB {{ site.data.products.advanced }} advanced clusters have a **PCI ready** panel to monitor the status of security features required for [PCI readiness]({% link cockroachcloud/pci-dss.md %}). Feature statuses will update from **INACTIVE** to **ACTIVE** once you configure them. Learn more about configuring these features: +CockroachDB {{ site.data.products.advanced }} advanced clusters have a **PCI DSS Ready** page in the {{ site.data.products.cloud }} Console to monitor the status of security features required for [PCI readiness]({% link cockroachcloud/pci-dss.md %}). Feature statuses will update from **INACTIVE** to **ACTIVE** once you configure them. Learn more about configuring these features: - [CockroachDB {{ site.data.products.cloud }} Organization Audit logs]({% link cockroachcloud/cloud-org-audit-logs.md %}) - [Customer-Managed Encryption Keys (CMEK)]({% link cockroachcloud/managing-cmek.md %}) @@ -184,8 +183,13 @@ CockroachDB {{ site.data.products.advanced }} advanced clusters have a **PCI rea - Single Sign-On (SSO) for your [CockroachDB {{ site.data.products.cloud }} organization]({% link cockroachcloud/configure-cloud-org-sso.md %}) and your [clusters]({% link cockroachcloud/cloud-sso-sql.md %}) - [Network security]({% link cockroachcloud/network-authorization.md %}) -You can also check the status of these features on the [**PCI ready**]({% link cockroachcloud/cluster-overview-page.md %}) page of the CockroachDB {{ site.data.products.cloud }} Console. +## Enable deletion protection + +To help prevent a cluster from being deleted by mistake, you can enable _deletion protection_. Before you can delete a cluster with deletion protection enabled, you must disable deletion protection. A user with permission to delete a cluster can enable deletion protection on the same cluster. +1. Navigate to the **Overview** page for the cluster you want to protect. +1. Click on **Settings** to open the **Cluster settings** panel. +1. If deletion protection is off, click **Edit**. Toggle the setting, then click **Save**. ## Delete cluster @@ -199,8 +203,8 @@ You will only be billed for a CockroachDB {{ site.data.products.advanced }} clus Proceed with the following steps only if you are sure you want to delete a cluster: -1. Navigate to the **Overview** page for the cluster you want to delete. -1. Click the **Actions** button in the top right corner. +1. Turn off [deletion protection](#enable-deletion-protection) if it is enabled. +1. Click on the three-dots menu. 1. Select **Delete cluster**. 1. In the confirmation window, enter the name of the cluster. 1. Click **Delete**. diff --git a/src/current/cockroachcloud/authorization.md b/src/current/cockroachcloud/authorization.md index 2f39a56e28f..279c920dc81 100644 --- a/src/current/cockroachcloud/authorization.md +++ b/src/current/cockroachcloud/authorization.md @@ -78,7 +78,7 @@ The **Cluster Operator** role allows actions that are dependent on whether it is - *Users* with this role can perform the following *console operations*: - - View a cluster's [Overview page]({% link cockroachcloud/cluster-overview-page.md %}), which displays its configuration, attributes and statistics, including cloud provider, region topography, and available and maximum storage and request units. + - View a cluster's [Overview page]({% link cockroachcloud/overview-page.md %}), which displays its configuration, attributes and statistics, including cloud provider, region topography, and available and maximum storage and request units. - Manage a cluster's databases from the [Databases Page]({% link cockroachcloud/databases-page.md %}). - [Scale a cluster's nodes]({% link cockroachcloud/advanced-cluster-management.md %}#scale-your-cluster). - View and configure a cluster's authorized networks from the [Networking Page]({% link cockroachcloud/network-authorization.md %}). @@ -89,7 +89,7 @@ The **Cluster Operator** role allows actions that are dependent on whether it is - View a cluster's Metrics from the [Metrics page]({% link cockroachcloud/metrics.md %}#cockroachdb-cloud-console-metrics-page). - View a cluster's Insights from the [Insights page]({% link cockroachcloud/insights-page.md %}). - [Upgrade]({% link cockroachcloud/upgrade-cockroach-version.md %}) a cluster's major version of CockroachDB. - - View a cluster's [PCI-readiness status (Advanced clusters with Security add-on only)]({% link cockroachcloud/cluster-overview-page.md %}?filters=advanced#pci-ready-with-security-add-on). + - View a cluster's [PCI-readiness status (Advanced clusters with Security add-on only)]({% link cockroachcloud/overview-page.md %}?filters=advanced#pci-ready-with-security-add-on). - Send a test alert from the [Alerts Page]({% link cockroachcloud/alerts-page.md %}). - Configure single sign-on (SSO) enforcement. - Access the [DB Console]({% link cockroachcloud/network-authorization.md %}#db-console). diff --git a/src/current/cockroachcloud/basic-cluster-management.md b/src/current/cockroachcloud/basic-cluster-management.md index 2b4ca340270..a640555c3ff 100644 --- a/src/current/cockroachcloud/basic-cluster-management.md +++ b/src/current/cockroachcloud/basic-cluster-management.md @@ -17,7 +17,9 @@ To view and manage a specific cluster, click the name of the cluster. The [**Ove ## View cluster overview -The **Overview** page displays details about the selected CockroachDB {{ site.data.products.basic }} cluster. For more information, see [Cluster Overview Page]({% link cockroachcloud/cluster-overview-page.md %}). +The **Overview** page displays details about the selected CockroachDB {{ site.data.products.basic }} cluster. For more information, see [Overview Page]({% link cockroachcloud/overview-page.md %}). + +Click the **Connect** button to get client connection details for your cluster. For more information, see [Connect to Your CockroachDB {{ site.data.products.advanced }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}). ## Edit labels @@ -31,8 +33,11 @@ This feature is not available if your organization is billed through [Credits]({ The monthly cost estimate is calculated using simple extrapolation that assumes your workload during the selected time frame is an accurate representation of your workload over the month. If you haven't been running a workload for at least the length of the selected time frame, your results will be inaccurate. -1. In the **Capacity used this month** section of your cluster's [**Overview** page]({% link cockroachcloud/cluster-overview-page.md %}), click **Update capacity**. -1. On the **Edit cluster** page, navigate to **Capacity**. +1. Click on the three-dots menu and select **Edit cluster**. + + The **Edit cluster** page displays. + +1. Click on **Next: Capacity** to open the **Capacity** page. 1. Under the **Estimate cost based on usage** section, select a time period in which your workload was active. Your used [RUs]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units), used storage, and accrued costs during the time period will be shown along with a monthly cost estimate. The accrued costs and monthly cost estimate do not account for the [$15 of free resources each month]({% link cockroachcloud/plan-your-cluster-basic.md %}#free-vs-paid-usage) granted to each organization (excluding those with annual or multi-year contracts), which you would have to use up before being charged. @@ -41,8 +46,11 @@ The monthly cost estimate is calculated using simple extrapolation that assumes The price-performance characteristics of CockroachDB {{ site.data.products.basic }} vary significantly depending on the workload. It can be difficult to estimate a workload's compute requirements in advance. With {{ site.data.products.basic }}, by default compute and storage scale with your cluster's needs, but you can limit a cluster's resource usage: -1. In the **Capacity used this month** section of your cluster's [**Overview** page]({% link cockroachcloud/cluster-overview-page.md %}), click **Update capacity**. +1. Click on the three-dots menu and select **Edit cluster**. + + The **Edit cluster** page displays. +1. Click on **Next: Capacity** to open the **Capacity** page. 1. On the **Capacity** page, edit the resource limits. In the sidebar, click **Update cluster**. Changes apply to the current and future billing cycles. For more details, refer to [Plan a CockroachDB {{ site.data.products.basic }} cluster]({% link cockroachcloud/plan-your-cluster-basic.md %}). @@ -60,7 +68,7 @@ You can only add regions to clusters created after May 16, 2023. To add regions to your cluster: 1. Navigate to the cluster's **Overview** page. -1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**. +1. Click on **Configuration** to expand the **Cluster configuration** section, then click on **Edit** next to the cluster's **Regions**. The **Edit cluster** page displays. @@ -74,7 +82,7 @@ To add regions to your cluster: To set the primary region: 1. Navigate to the cluster's **Overview** page. -1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**. +1. Click on **Configuration** to expand the **Cluster configuration** section, then click on **Edit** next to the cluster's **Regions**. The **Edit cluster** page displays. @@ -106,7 +114,8 @@ You can also [back up and restore]({% link cockroachcloud/take-and-restore-self- To help prevent a cluster from being deleted by mistake, you can enable _deletion protection_. Before you can delete a cluster with deletion protection enabled, you must disable deletion protection. A user with permission to delete a cluster can enable deletion protection on the same cluster. 1. Navigate to the **Overview** page for the cluster you want to protect. -1. If deletion protection is disabled, click the pencil icon next to it. Toggle the setting, then click **Save**. +1. Click on **Settings** to open the **Cluster settings** panel. +1. If deletion protection is off, click **Edit**. Toggle the setting, then click **Save**. ## Delete cluster @@ -120,9 +129,8 @@ Free CockroachDB {{ site.data.products.basic }} clusters are subject to deletion Proceed with the following steps only if you are sure you want to delete a cluster: -1. Navigate to the **Overview** page for the cluster you want to delete. -1. If [deletion protection](#enable-deletion-protection) is enabled, click the pencil icon next to it. Toggle the setting, then click **Save**. -1. Click the **Actions** button in the top right corner. +1. Turn off [deletion protection](#enable-deletion-protection) if it is enabled. +1. Click on the three-dots menu. 1. Select **Delete cluster**. 1. In the confirmation window, enter the name of the cluster. 1. Click **Delete**. diff --git a/src/current/cockroachcloud/change-plan-between-basic-and-standard.md b/src/current/cockroachcloud/change-plan-between-basic-and-standard.md index a179f66fa60..d5222be7dea 100644 --- a/src/current/cockroachcloud/change-plan-between-basic-and-standard.md +++ b/src/current/cockroachcloud/change-plan-between-basic-and-standard.md @@ -32,7 +32,7 @@ When you change from {{ site.data.products.standard }} to {{ site.data.products. {{site.data.alerts.end}} 1. On the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page), select the cluster that requires a plan change. -1. On the [**Cluster Overview** page]({% link cockroachcloud/cluster-overview-page.md %}), select the **Action** dropdown in the top-right corner, and then **Change plan type**. If this option is unavailable, refer to [Considerations](#considerations). +1. On the [**Overview** page]({% link cockroachcloud/overview-page.md %}), select the **Action** dropdown in the top-right corner, and then **Change plan type**. If this option is unavailable, refer to [Considerations](#considerations). 1. Choose a [plan]({% link cockroachcloud/index.md %}#plans) from {{ site.data.products.standard }} or {{ site.data.products.basic }} to change to. The current plan of the cluster will be labeled, while the other plan type will be highlighted. Select **Next: Capacity**. 1. For capacity: - If you are changing to a {{ site.data.products.standard }} plan, choose the amount of [provisioned capacity]({% link cockroachcloud/plan-your-cluster.md %}#provisioned-capacity) you want for your cluster. The Cloud Console provides a suggestion for provisioned vCPU, we recommend monitoring CPU utilization and adjusting the cluster's compute capacity as necessary. For additional information, refer to [Recommended provisioned capacity when changing cluster plan]({% link cockroachcloud/plan-your-cluster.md %}#recommended-provisioned-capacity-when-changing-cluster-plan). Select **Next: Finalize**. diff --git a/src/current/cockroachcloud/cluster-management.md b/src/current/cockroachcloud/cluster-management.md index af362eed8ad..18b3b8cdc05 100644 --- a/src/current/cockroachcloud/cluster-management.md +++ b/src/current/cockroachcloud/cluster-management.md @@ -25,9 +25,9 @@ To view and manage a specific cluster, click the name of the cluster. The [**Ove ## View cluster overview -The [**Overview** page]({% link cockroachcloud/cluster-overview-page.md %}) displays details about the selected CockroachDB {{ site.data.products.cloud }} cluster. +The [**Overview** page]({% link cockroachcloud/overview-page.md %}) displays details about the selected CockroachDB {{ site.data.products.cloud }} cluster. -From the **Overview** page, you can connect to your cluster. For more information, refer to [Connect to Your CockroachDB {{ site.data.products.standard }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}). +Click the **Connect** button to get client connection details for your cluster. For more information, refer to [Connect to Your CockroachDB {{ site.data.products.standard }} Cluster]({% link cockroachcloud/connect-to-your-cluster.md %}). ## Edit labels @@ -35,8 +35,7 @@ You can [organize CockroachDB {{ site.data.products.cloud }} clusters using labe ## Add a region to your cluster -1. Navigate to the cluster's **Overview** page. -1. In the **Cluster settings** section, click the pencil icon next to the cluster's **Regions**. +1. Click on the three-dots menu and select **Edit cluster**. The **Edit Cluster** page displays. @@ -50,9 +49,11 @@ The price-performance characteristics of CockroachDB {{ site.data.products.stand To edit your cluster's capacity: -1. Navigate to the cluster's **Overview** page. -1. In the **Capacity** section, click **Update capacity**. - The **Capacity** page displays. +1. Click on the three-dots menu and select **Edit cluster**. + + The **Edit cluster** page displays. + +1. Click on **Next: Capacity** to open the **Capacity** page. 1. Enter the desired number of request units per second or use the slider to increase or decrease the request units per second. {{site.data.alerts.callout_success}} @@ -92,7 +93,7 @@ If you disable automatic major-version upgrades for a cluster, to maintain suppo To disable automatic major-version upgrades for a CockroachDB {{ site.data.products.standard }} cluster: -1. On the [**Cluster Overview** page for the cluster](#view-cluster-overview), click **Actions**, then select **Manual upgrade settings**. +1. On the [**Overview** page for the cluster](#view-cluster-overview), click **Settings** to open the **Cluster settings** panel. Click **Edit** next to **Manual upgrades**. 1. Read the information provided, then set **Manual upgrades** to **on**. 1. Click **Apply**. @@ -127,7 +128,8 @@ You can also [back up and restore]({% link cockroachcloud/take-and-restore-self- To help prevent a cluster from being deleted by mistake, you can enable _deletion protection_. Before you can delete a cluster with deletion protection enabled, you must disable deletion protection. A user with permission to delete a cluster can enable deletion protection on the same cluster. 1. Navigate to the **Overview** page for the cluster you want to protect. -1. If deletion protection is disabled, click the pencil icon next to it. Toggle the setting, then click **Save**. +1. Click on **Settings** to open the **Cluster settings** panel. +1. If deletion protection is off, click **Edit**. Toggle the setting, then click **Save**. ## Delete cluster @@ -141,9 +143,8 @@ You will be billed only for a CockroachDB {{ site.data.products.standard }} clus Proceed with the following steps only if you are sure you want to delete a cluster: -1. Navigate to the **Overview** page for the cluster you want to delete. -1. If [deletion protection](#enable-deletion-protection) is enabled, click the pencil icon next to it. Toggle the setting, then click **Save**. -1. Click the **Actions** button in the top right corner. +1. Turn off [deletion protection](#enable-deletion-protection) if it is enabled. +1. Click on the three-dots menu. 1. Select **Delete cluster**. 1. In the confirmation window, enter the name of the cluster. 1. Click **Delete**. diff --git a/src/current/cockroachcloud/cluster-overview-page.md b/src/current/cockroachcloud/cluster-overview-page.md deleted file mode 100644 index 85ea59b2b1a..00000000000 --- a/src/current/cockroachcloud/cluster-overview-page.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: Cluster Overview Page -summary: How to use the Cluster Overview page to view cluster details on CockroachDB Cloud. -toc: true -docs_area: manage ---- - -The **Cluster Overview** page displays key metrics about your CockroachDB {{ site.data.products.cloud }} cluster. To view this page, click on a cluster from the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page). - -
- - -
- -
- -## Cluster settings - -The **Cluster settings** panel shows the settings selected during [cluster creation]({% link cockroachcloud/create-a-basic-cluster.md %}), as well as any [labels]({% link cockroachcloud/labels.md %}) added to the cluster after its creation. - -| Field | Description | -|-----------|---------------------------------------------------------------------------------------------------------| -| Cloud | The cluster's [cloud provider]({% link cockroachcloud/create-a-basic-cluster.md %}#step-2-select-the-cloud-provider). | -| Plan type | The plan type used to create the cluster. | -| Regions | The cluster's [regions]({% link cockroachcloud/create-a-basic-cluster.md %}#step-3-select-the-regions). | -| Labels | The [labels]({% link cockroachcloud/labels.md %}) added to the cluster. | - -## Capacity used this month - -The **Capacity used this month** panel displays your cluster usage statistics for the current month. You can click [**Estimate usage cost**]({% link cockroachcloud/basic-cluster-management.md %}#estimate-usage-cost) to open a tool that estimates your monthly costs based on your workload during a selected time frame. - -| Field | Description | -|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| Capacity used | The CockroachDB {{ site.data.products.standard }} or {{ site.data.products.basic }} cluster's [configured capacity]({% link cockroachcloud/create-a-basic-cluster.md %}#step-4-configure-cluster-capacity). Click the **edit** icon to change the configured capacity. | -| [Request Units]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units) | The CPU and I/O resources being used by queries on the cluster, and whether throttling is in effect. The total available RUs are determined by your configured capacity. | -| Storage | The amount of data currently stored in the cluster. This value does not account for compression or replication. The total available storage is determined by your configured capacity. | - - -## Current activity panel - -This panel displays operational statistics for your cluster. - -| Field | Description | -|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------| -| Throughput | The cluster throughput in queries per second (QPS). | -| P99 latency | The 99th percentile of service latency. This value indicates the time within which the cluster executed 99 percent of queries over the last minute. | | -| Open sessions | The number of open sessions in the cluster. | - -## Cluster Overview metrics - -These time-series graphs display important cluster metrics over time. - -You can use the timeframe selector above the graphs to view data for a specific time period. - -### Request Units - -The **Request Units** graph displays the CPU and I/O resources being used by queries on the cluster. This is measured in Request Units per second at each timestamp. Simple queries consume few RUs, while complicated queries with many reads and writes consume more RUs. - -### Storage Used - -The **Storage Used** graph displays the amount of data being stored in the cluster over time. This is the logical number of live bytes and does not account for compression or replication. - -### SQL Statements - -The **SQL Statements** graph displays an average of the number of [`SELECT`]({% link {{site.current_cloud_version}}/select-clause.md %}), [`INSERT`]({% link {{site.current_cloud_version}}/insert.md %}), [`UPDATE`]({% link {{site.current_cloud_version}}/update.md %}), and [`DELETE`]({% link {{site.current_cloud_version}}/delete.md %}) statements successfully executed per second. - -
- -
- -## Cluster configuration - -The **Cluster configuration** panel displays the settings you chose during [cluster creation]({% link cockroachcloud/create-your-cluster.md %}). - -| Field | Description | -|-----------|---------------------------------------------------------------------------------------------------------| -| Cloud | The cluster's [cloud provider]({% link cockroachcloud/create-an-advanced-cluster.md %}#step-2-select-the-cloud-provider). | -| Plan type | The [plan type]({% link cockroachcloud/create-an-advanced-cluster.md %}#step-1-start-the-cluster-creation-process) used to create the cluster. | -| Regions | The cluster's [region]({% link cockroachcloud/create-an-advanced-cluster.md %}#step-3-configure-regions-and-nodes). | -| Nodes | The [number of nodes]({% link cockroachcloud/create-an-advanced-cluster.md %}#step-3-configure-regions-and-nodes) the cluster has and the status of each. | -| Compute | The cluster's [compute power per node]({% link cockroachcloud/create-an-advanced-cluster.md %}#step-5-configure-cluster-capacity). | -| Storage | The cluster's [storage per node]({% link cockroachcloud/create-an-advanced-cluster.md %}#step-5-configure-cluster-capacity). | - - -## PCI ready (with Security add-on) - -CockroachDB {{ site.data.products.advanced }} clusters with Security add-on have a **PCI ready** panel to monitor the status of security features required for [PCI readiness]({% link cockroachcloud/pci-dss.md %}). Feature statuses will update from **INACTIVE** to **ACTIVE** once you configure them. Learn more about configuring these features: - -- [CockroachDB {{ site.data.products.cloud }} Organization Audit logs]({% link cockroachcloud/cloud-org-audit-logs.md %}) -- [Cluster audit log export]({% link cockroachcloud/export-logs.md %}) -- [Customer-Managed Encryption Keys (CMEK)]({% link cockroachcloud/managing-cmek.md %}) -- [Egress Perimeter Controls]({% link cockroachcloud/egress-perimeter-controls.md %}) -- Single Sign-On (SSO) for your [CockroachDB {{ site.data.products.cloud }} organization]({% link cockroachcloud/configure-cloud-org-sso.md %}) and your [clusters]({% link cockroachcloud/cloud-sso-sql.md %}) -- [Network security]({% link cockroachcloud/network-authorization.md %}) - -
diff --git a/src/current/cockroachcloud/connect-to-a-basic-cluster.md b/src/current/cockroachcloud/connect-to-a-basic-cluster.md index dfbdee4fad8..9f626184da6 100644 --- a/src/current/cockroachcloud/connect-to-a-basic-cluster.md +++ b/src/current/cockroachcloud/connect-to-a-basic-cluster.md @@ -31,7 +31,7 @@ Removing or adding an authorized network on your CockroachDB {{ site.data.produc ## Connect to your cluster -1. Select your cluster to navigate to the cluster [**Overview** page]({% link cockroachcloud/cluster-overview-page.md %}). +1. Select your cluster to navigate to the cluster [**Overview** page]({% link cockroachcloud/overview-page.md %}). 1. In the top right corner of the CockroachDB {{ site.data.products.cloud }} Console, click the **Connect** button. diff --git a/src/current/cockroachcloud/connect-to-the-cockroachdb-cloud-mcp-server.md b/src/current/cockroachcloud/connect-to-the-cockroachdb-cloud-mcp-server.md index 3d8d928fde8..0baf3aeea79 100644 --- a/src/current/cockroachcloud/connect-to-the-cockroachdb-cloud-mcp-server.md +++ b/src/current/cockroachcloud/connect-to-the-cockroachdb-cloud-mcp-server.md @@ -16,7 +16,7 @@ This page explains how to connect your AI tools to the CockroachDB Cloud MCP ser ## Before you begin - [Create a CockroachDB cluster]({% link cockroachcloud/create-a-basic-cluster.md %}). - - Note the Cluster ID in the URL of the [Cluster Overview Page]({% link cockroachcloud/cluster-overview-page.md %}): `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`. + - Note the Cluster ID in the URL of the [Overview page]({% link cockroachcloud/overview-page.md %}): `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`. - If you plan to connect to the MCP server using OAuth, ensure that the user managing the MCP server connection [is able to log in]({% link cockroachcloud/authentication.md %}) to the Cloud Console. Ensure that the user has been assigned the [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) role or the [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) role. - If you plan to connect to the MCP server using an API key, create a [service account]({% link cockroachcloud/managing-access.md %}#manage-service-accounts) and an [API key]({% link cockroachcloud/managing-access.md %}#api-access) in the CockroachDB Cloud Console. Ensure that the service account has been assigned the [Cluster Admin]({% link cockroachcloud/authorization.md %}#cluster-admin) role or the [Cluster Operator]({% link cockroachcloud/authorization.md %}#cluster-operator) role. - Copy the secret key that's generated upon service account creation. @@ -171,7 +171,7 @@ For help configuring Claude Code, refer to the [Claude Code documentation](https #### Option 1: Automatic installation -1. Navigate to the [Cluster Overview Page]({% link cockroachcloud/cluster-overview-page.md %}) for the cluster that you want to manage with the MCP server connection. +1. Navigate to the [Overview page]({% link cockroachcloud/overview-page.md %}) for the cluster that you want to manage with the MCP server connection. 2. Select **Connect**, then the **Model Context Protocol (MCP)** tab. 3. Select **Cursor** as the MCP Client. 4. Select **Add to Cursor**. @@ -319,7 +319,7 @@ For help configuring Cline, refer to the [Cline documentation](https://docs.clin #### Option 1: Automatic installation -1. Navigate to the [Cluster Overview Page]({% link cockroachcloud/cluster-overview-page.md %}) for the cluster that you want to manage with the MCP server connection. +1. Navigate to the [Overview page]({% link cockroachcloud/overview-page.md %}) for the cluster that you want to manage with the MCP server connection. 2. Select **Connect**, then the **Model Context Protocol (MCP)** tab. 3. Select **GitHub Copilot** as the MCP Client. 4. Select **Add to GitHub Copilot**. diff --git a/src/current/cockroachcloud/export-metrics-advanced.md b/src/current/cockroachcloud/export-metrics-advanced.md index eb9c70ba10f..dd9601ec559 100644 --- a/src/current/cockroachcloud/export-metrics-advanced.md +++ b/src/current/cockroachcloud/export-metrics-advanced.md @@ -290,7 +290,7 @@ For CockroachDB {{ site.data.products.advanced }} clusters hosted on AWS and GCP Where: - `{cluster_id}` is your CockroachDB {{ site.data.products.advanced }} cluster ID as determined in step 1, resembling `f78b7feb-b6cf-4396-9d7f-494982d7d81e`. - - `{cluster_region}` is a region of your CockroachDB {{ site.data.products.advanced }} cluster as shown in the `targets` of step 3, such as `us-east4`. You can also find your cluster’s region(s) on the [Cluster Overview page]({% link cockroachcloud/cluster-overview-page.md %}). + - `{cluster_region}` is a region of your CockroachDB {{ site.data.products.advanced }} cluster as shown in the `targets` of step 3, such as `us-east4`. You can also find your cluster’s region(s) on the [Overview page]({% link cockroachcloud/overview-page.md %}). - `{secret_key}` is your CockroachDB {{ site.data.products.advanced }} API key. See [API Access]({% link cockroachcloud/managing-access.md %}) for instructions on generating this key. Metrics are labeled with the cluster name and ID, node, organization name, and region. The beginning lines of a metrics scrape response follows: @@ -335,7 +335,7 @@ For CockroachDB {{ site.data.products.advanced }} clusters hosted on AWS and GCP Where: - `{job_name}` is a job name you assign to scraped metrics by default, such as `scrape-cockroach-us-east4`. - `{cluster_id}` is your CockroachDB {{ site.data.products.advanced }} cluster ID as determined in step 1, resembling `f78b7feb-b6cf-4396-9d7f-494982d7d81e`. - - `{cluster_region}` is a region of your CockroachDB {{ site.data.products.advanced }} cluster as shown in the `targets` of step 3, such as `us-east4`. You can also find your cluster’s region(s) on the [Cluster Overview page]({% link cockroachcloud/cluster-overview-page.md %}). + - `{cluster_region}` is a region of your CockroachDB {{ site.data.products.advanced }} cluster as shown in the `targets` of step 3, such as `us-east4`. You can also find your cluster’s region(s) on the [Overview page]({% link cockroachcloud/overview-page.md %}). - `{secret_key}` is your CockroachDB {{ site.data.products.advanced }} API key. See [API Access]({% link cockroachcloud/managing-access.md %}) for instructions on generating this key. diff --git a/src/current/cockroachcloud/export-metrics.md b/src/current/cockroachcloud/export-metrics.md index 857bd1d21f1..496780701f6 100644 --- a/src/current/cockroachcloud/export-metrics.md +++ b/src/current/cockroachcloud/export-metrics.md @@ -284,7 +284,7 @@ A subset of CockroachDB metrics require that you explicitly [enable percentiles] Where: - `{cluster_id}` is your CockroachDB {{ site.data.products.standard }} cluster ID as determined in step 1, resembling `f78b7feb-b6cf-4396-9d7f-494982d7d81e`. - - `{cluster_region}` is a region of your CockroachDB {{ site.data.products.standard }} cluster as shown in the `targets` of step 3, such as `us-east4`. You can also find your cluster’s region(s) on the [Cluster Overview page]({% link cockroachcloud/cluster-overview-page.md %}). + - `{cluster_region}` is a region of your CockroachDB {{ site.data.products.standard }} cluster as shown in the `targets` of step 3, such as `us-east4`. You can also find your cluster’s region(s) on the [Overview page]({% link cockroachcloud/overview-page.md %}). - `{secret_key}` is your CockroachDB {{ site.data.products.standard }} API key. See [API Access]({% link cockroachcloud/managing-access.md %}) for instructions on generating this key. Metrics are labeled with the cluster name, organization name, and region. The beginning lines of a metrics scrape response follows: @@ -328,7 +328,7 @@ A subset of CockroachDB metrics require that you explicitly [enable percentiles] Where: - `{job_name}` is a job name you assign to scraped metrics by default, such as `scrape-cockroach-us-east4`. - `{cluster_id}` is your CockroachDB {{ site.data.products.standard }} cluster ID as determined in step 1, resembling `f78b7feb-b6cf-4396-9d7f-494982d7d81e`. - - `{cluster_region}` is a region of your CockroachDB {{ site.data.products.standard }} cluster as shown in the `targets` of step 3, such as `us-east4`. You can also find your cluster’s region(s) on the [Cluster Overview page]({% link cockroachcloud/cluster-overview-page.md %}). + - `{cluster_region}` is a region of your CockroachDB {{ site.data.products.standard }} cluster as shown in the `targets` of step 3, such as `us-east4`. You can also find your cluster’s region(s) on the [Overview page]({% link cockroachcloud/overview-page.md %}). - `{secret_key}` is your CockroachDB {{ site.data.products.standard }} API key. See [API Access]({% link cockroachcloud/managing-access.md %}) for instructions on generating this key. diff --git a/src/current/cockroachcloud/overview-page.md b/src/current/cockroachcloud/overview-page.md new file mode 100644 index 00000000000..4d157c17b5a --- /dev/null +++ b/src/current/cockroachcloud/overview-page.md @@ -0,0 +1,71 @@ +--- +title: Overview Page +summary: How to use the Overview page to view cluster details on CockroachDB Cloud. +toc: true +docs_area: manage +--- + +The **Overview** page displays details and key metrics about your CockroachDB {{ site.data.products.cloud }} cluster. To view this page, click on a cluster from the [**Clusters** page]({% link cockroachcloud/cluster-management.md %}#view-clusters-page). + +The information displayed on this page in the Console may differ for you based on your assigned [roles]({% link cockroachcloud/authorization.md %}). + +## Configuration + +The **Configuration** section displays high-level details about the cluster. Clicking on this section expands the **Cluster configuration** panel that displays the following cluster details and settings you chose during [cluster creation]({% link cockroachcloud/create-your-cluster.md %}): + +| Field | Description | +|-----------------------------------------------|-----------------------------------------------------------------------------------------------------------------| +| Plan type | The plan type of the cluster. | +| Cloud | The cluster's cloud provider. | +| Region(s) | The cluster's regions. | +| Compute | The cluster's provisioned compute power as appropriate for the [plan type]({% link cockroachcloud/costs.md %}). | +| Storage | The cluster's provisioned storage as appropriate for the [plan type]({% link cockroachcloud/costs.md %}). | +| Nodes ({{ site.data.products.advanced}} only) | The number of nodes the cluster has and the status of each. | +| Labels | The [labels]({% link cockroachcloud/labels.md %}) applied to the cluster. | +| Cluster created on | The creation date of the cluster. | + +## Settings + +The **Settings** section shows the [CockroachDB version]({% link releases/index.md %}) running on the cluster. Clicking on this section expands the **Cluster settings** panel which includes the following options for managing this cluster: + +- [**Maintenance window**]({% link cockroachcloud/advanced-cluster-management.md %}#set-a-maintenance-window) ({{ site.data.products.advanced }} only) +- [**Delay patch upgrades**]({% link cockroachcloud/cluster-management.md %}#set-a-maintenance-window) ({{ site.data.products.advanced }} only) +- [**Deletion protection**]({% link cockroachcloud/cluster-management.md %}#enable-deletion-protection) +- [**Manual upgrades**]({% link cockroachcloud/cluster-management.md %}#manage-cluster-upgrades) ({{ site.data.products.standard }} only) + +## Usage graphs + +The Overview page includes graphs that display real-time metrics about the high level performance and usage of the cluster. You can modify the timeframe displayed on these graphs with the timeframe dropdown. You can also click on the **View all metrics** link to go to the [**Metrics** page]({% link cockroachcloud/metrics.md %}). + +### SQL throughput and SQL latency + +The **SQL throughput and SQL latency** graph displays the average queries-per-second (QPS) and 99th percentile of service latency (p99 latency) of [`SELECT`]({% link {{site.current_cloud_version}}/select-clause.md %}), [`INSERT`]({% link {{site.current_cloud_version}}/insert.md %}), [`UPDATE`]({% link {{site.current_cloud_version}}/update.md %}), and [`DELETE`]({% link {{site.current_cloud_version}}/delete.md %}) statements successfully executed per second on the cluster. + +### Compute used + +The **Compute used** graph displays your cluster compute usage statistics for the specified timeframe. On {{ site.data.products.basic }} clusters this graph displays request units (RUs) per second. On {{ site.data.products.standard }} and {{ site.data.products.advanced }} clusters this graph displays total vCPU compute per second. + +## Cluster resource totals + +The Overview page describes the total provisioned compute and storage for the cluster. Usage costs are [calculated differently based on the cluster's plan]({% link cockroachcloud/costs.md %}) so the displayed information differs based on the cluster's plan: + +### {{ site.data.products.basic }} cluster resources + +| Section | Description | +|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Request units | The CPU and I/O resources being used by queries on the cluster, and whether throttling is in effect. The total available RUs are determined by your configured capacity. | +| Storage | The amount of data currently stored in the cluster. This value does not account for compression or replication. The total available storage is determined by your configured capacity. | + +### {{ site.data.products.standard }} cluster resources + +| Section | Description | +|---------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Provisioned compute | The number of vCPUs provisioned to process queries on the cluster. | +| Storage | The amount of data currently stored in the cluster. This value does not account for compression or replication. The total available storage is determined by your configured capacity. | + +### {{ site.data.products.advanced }} cluster resources + +| Section | Description | +|---------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Nodes | The number of nodes the cluster has and the status of each. | +| Storage | The amount of data currently stored in the cluster. This value does not account for compression or replication. The total available storage is determined by your configured capacity. | diff --git a/src/current/cockroachcloud/pci-dss.md b/src/current/cockroachcloud/pci-dss.md index bbb63bde517..a3e199d85dc 100644 --- a/src/current/cockroachcloud/pci-dss.md +++ b/src/current/cockroachcloud/pci-dss.md @@ -86,6 +86,8 @@ When a system complies with PCI DSS, the system meets the goals of the standard CockroachDB {{ site.data.products.advanced }} is certified by a PCI QSA to be compliant with [PCI DSS 4.0](https://docs-prv.pcisecuritystandards.org/PCI%20DSS/Reporting%20Template%20or%20Form/PCI-DSS-v4-0-1-ROC-AOC-Merchants.pdf) within the DBaaS platform. Customers are still responsible to ensure that their applications are PCI DSS compliant. Customers may need to take the additional actions outlined in [Responsibilities of the customer](#responsibilities-of-the-customer) to maintain their own PCI compliance when using CockroachDB {{ site.data.products.advanced }} clusters for cardholder data or other sensitive data. +The **PCI DSS Ready** page in the CockroachDB {{ site.data.products.cloud }} console allows you to track your cluster's utilization of advanced security features that enable the cluster's PCI DSS readiness. + ## Responsibilities of Cockroach Labs Cockroach Labs takes actions to ensure that the operating procedures and the deployment environment for CockroachDB {{ site.data.products.advanced }} clusters meet or exceed the requirements of PCI DSS 4.0. Some of these actions include: diff --git a/src/current/cockroachcloud/physical-cluster-replication.md b/src/current/cockroachcloud/physical-cluster-replication.md index 6b06de3dae2..7ad78589248 100644 --- a/src/current/cockroachcloud/physical-cluster-replication.md +++ b/src/current/cockroachcloud/physical-cluster-replication.md @@ -164,7 +164,7 @@ Replace: You can find the cluster IDs in the cluster creation output, or in the URL of the single cluster overview page: `https://cockroachlabs.cloud/cluster/{your_cluster_id}/overview`. The ID will resemble `ad1e8630-729a-40f3-87e4-9f72eb3347a0`. {{site.data.alerts.callout_info}} -Once you have started PCR, the standby cluster cannot accept writes and reads, therefore the [Cloud Console]({% link cockroachcloud/cluster-overview-page.md %}) and SQL shell will be unavailable prior to [failover](#fail-over-to-the-standby-cluster). +Once you have started PCR, the standby cluster cannot accept writes and reads, therefore the [Cloud Console]({% link cockroachcloud/overview-page.md %}) and SQL shell will be unavailable prior to [failover](#fail-over-to-the-standby-cluster). {{site.data.alerts.end}} You will receive a response similar to: diff --git a/src/current/cockroachcloud/plan-your-cluster-basic.md b/src/current/cockroachcloud/plan-your-cluster-basic.md index aedb0347593..4cad8e43b15 100644 --- a/src/current/cockroachcloud/plan-your-cluster-basic.md +++ b/src/current/cockroachcloud/plan-your-cluster-basic.md @@ -25,7 +25,7 @@ RU and storage consumption is prorated at the following prices: 1M Request Units | $0.20 1 GiB storage | $0.50 -Refer to [Pricing](https://cockroachlabs.com/pricing) to see cost estimates of common queries and how they increase with the size and complexity of the query. You can view your cluster's RU and storage usage on the [**Cluster Overview** page]({% link cockroachcloud/cluster-overview-page.md %}). +Refer to [Pricing](https://cockroachlabs.com/pricing) to see cost estimates of common queries and how they increase with the size and complexity of the query. You can view your cluster's RU and storage usage on the [**Overview** page]({% link cockroachcloud/overview-page.md %}). ## Free vs. paid usage diff --git a/src/current/cockroachcloud/production-checklist.md b/src/current/cockroachcloud/production-checklist.md index 816e58852a7..782c2f534d9 100644 --- a/src/current/cockroachcloud/production-checklist.md +++ b/src/current/cockroachcloud/production-checklist.md @@ -147,4 +147,4 @@ CockroachDB {{ site.data.products.advanced }} has access to all features require - Single Sign-On (SSO) for your [CockroachDB {{ site.data.products.cloud }} organization]({% link cockroachcloud/configure-cloud-org-sso.md %}) and your [clusters]({% link cockroachcloud/cloud-sso-sql.md %}) - [Network security]({% link cockroachcloud/network-authorization.md %}) -You can check the status of these features on the [**PCI ready**]({% link cockroachcloud/cluster-overview-page.md %}?filters=advanced#pci-ready) page of the CockroachDB {{ site.data.products.cloud }} Console. +The **PCI DSS Ready** page in the CockroachDB {{ site.data.products.cloud }} console allows you to track your cluster's utilization of advanced security features that enable the cluster's PCI DSS readiness. diff --git a/src/current/cockroachcloud/troubleshooting-page.md b/src/current/cockroachcloud/troubleshooting-page.md index 34d7ea4d0aa..6152c9b9891 100644 --- a/src/current/cockroachcloud/troubleshooting-page.md +++ b/src/current/cockroachcloud/troubleshooting-page.md @@ -172,7 +172,7 @@ If you are experiencing access issues, ensure that the password is correct. If t ### Hanging or stuck queries -A hanging or stuck query using a CockroachDB {{ site.data.products.basic }} or {{ site.data.products.standard }} cluster may be caused by reaching the cluster's configured [resource limits]({% link cockroachcloud/plan-your-cluster-basic.md %}#choose-resource-limits) for [Request Units]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units) or storage space. SQL Statements and `cockroach` CLI commands may be impacted. You can check your cluster's resource limits and status from the [**Cluster Overview** page]({% link cockroachcloud/cluster-overview-page.md %}) in the Cloud Console. Resource limits are displayed in **Usage this month**. If you've used all your storage, your cluster will be labeled **THROTTLED**, and you will be limited to a single SQL connection which you can use to delete data. If you've used all your RUs, your cluster will be **DISABLED**. +A hanging or stuck query using a CockroachDB {{ site.data.products.basic }} or {{ site.data.products.standard }} cluster may be caused by reaching the cluster's configured [resource limits]({% link cockroachcloud/plan-your-cluster-basic.md %}#choose-resource-limits) for [Request Units]({% link cockroachcloud/plan-your-cluster-basic.md %}#request-units) or storage space. SQL Statements and `cockroach` CLI commands may be impacted. You can check your cluster's resource limits and status from the [**Overview** page]({% link cockroachcloud/overview-page.md %}) in the Cloud Console. Resource limits are displayed in **Usage this month**. If you've used all your storage, your cluster will be labeled **THROTTLED**, and you will be limited to a single SQL connection which you can use to delete data. If you've used all your RUs, your cluster will be **DISABLED**.

Solution

diff --git a/src/current/releases/cloud.md b/src/current/releases/cloud.md index 8ede0a64374..5c1830fb2b3 100644 --- a/src/current/releases/cloud.md +++ b/src/current/releases/cloud.md @@ -675,8 +675,8 @@ For an in-depth explanation of CockroachDB {{ site.data.products.serverless }} p

Console changes

-- CockroachDB {{ site.data.products.basic }} clusters' regions are now displayed on the [**Cluster Overview** page]({% link cockroachcloud/cluster-overview-page.md %}) and [**Clusters** page]({% link cockroachcloud/basic-cluster-management.md %}#view-clusters-page). -- The links in the sidebar navigation of the [**Cluster Overview**]({% link cockroachcloud/cluster-overview-page.md %}) page have been reorganized into sections under relevant headers. +- CockroachDB {{ site.data.products.basic }} clusters' regions are now displayed on the [**Overview** page]({% link cockroachcloud/overview-page.md %}) and [**Clusters** page]({% link cockroachcloud/basic-cluster-management.md %}#view-clusters-page). +- The links in the sidebar navigation of the [**Cluster Overview**]({% link cockroachcloud/overview-page.md %}) page have been reorganized into sections under relevant headers. - For CockroachDB {{ site.data.products.dedicated }} clusters, the **Monitoring** page is now called the [**Tools** page]({% link cockroachcloud/tools-page.md %}) and is located in the **Monitoring** section of the sidebar.

Cloud API changes

@@ -761,7 +761,7 @@ For an in-depth explanation of CockroachDB {{ site.data.products.serverless }} p

Bug fixes

-- The **Sessions** link on the [**Overview**]({% link cockroachcloud/cluster-overview-page.md %}) page now redirects to the correct tab on the [**SQL Activity**]({% link cockroachcloud/sessions-page.md %}) page. +- The **Sessions** link on the [**Overview**]({% link cockroachcloud/overview-page.md %}) page now redirects to the correct tab on the [**SQL Activity**]({% link cockroachcloud/sessions-page.md %}) page. - Fixed a bug where stale data caused **Connect** modal errors immediately after creating a CockroachDB {{ site.data.products.serverless }} cluster. - Fixed a bug where backup metadata payloads were limited to 4MiB instead of the desired 32MiB. - Fixed a bug where the node-aggregated low disk alert was not firing. @@ -948,7 +948,7 @@ For an in-depth explanation of CockroachDB {{ site.data.products.serverless }} p

Bug fixes

- Fixed a number of broken links throughout the CockroachDB {{ site.data.products.cloud }} Console. -- Fixed a bug where CockroachDB {{ site.data.products.serverless }} users were seeing occasional dips and spikes in a cluster's [**Request Units**]({% link cockroachcloud/cluster-overview-page.md %}#request-units) usage graph while running a steady workload. +- Fixed a bug where CockroachDB {{ site.data.products.serverless }} users were seeing occasional dips and spikes in a cluster's [**Request Units**]({% link cockroachcloud/overview-page.md %}#request-units) usage graph while running a steady workload. ## January 10, 2022 @@ -979,7 +979,7 @@ For an in-depth explanation of CockroachDB {{ site.data.products.serverless }} p - Fixed a bug where an error was occurring on the [VPC Peering and AWS PrivateLink]({% link cockroachcloud/network-authorization.md %}) pages for clusters with a large number of jobs. - Fixed a bug where the **Test email alerts** section on the [**Alerts** page]({% link cockroachcloud/alerts-page.md %}) was not visible for organizations with only custom clusters. - Fixed a bug where users were prompted to upgrade CockroachDB {{ site.data.products.serverless }} clusters, which are [upgraded automatically]({% link cockroachcloud/upgrade-policy.md %}). -- Previously, [SQL metrics graphs]({% link cockroachcloud/cluster-overview-page.md %}) for inactive CockroachDB {{ site.data.products.serverless }} clusters showed discontinuous time series lines or an error message. Continuous graphs will now remain available for scaled-down clusters. +- Previously, [SQL metrics graphs]({% link cockroachcloud/overview-page.md %}) for inactive CockroachDB {{ site.data.products.serverless }} clusters showed discontinuous time series lines or an error message. Continuous graphs will now remain available for scaled-down clusters. ## November 8, 2021 @@ -994,13 +994,13 @@ For an in-depth explanation of CockroachDB {{ site.data.products.serverless }} p - The [**Statements**]({% link cockroachcloud/statements-page.md %}), [**Transactions**]({% link cockroachcloud/transactions-page.md %}), and [**Sessions**]({% link cockroachcloud/sessions-page.md %}) pages are now available for CockroachDB {{ site.data.products.serverless }} clusters on the **SQL Activity** page. - Statements and transaction statistics are now retained longer for all clusters. -- Legends are now displayed by default for time-series graphs on the [Cluster Overview]({% link cockroachcloud/cluster-overview-page.md %}#cluster-overview-metrics) page. -- The **Transaction retries** metric is no longer part of the **Current activity** panel on the CockroachDB {{ site.data.products.serverless }} [Cluster Overview]({% link cockroachcloud/cluster-overview-page.md %}#current-activity-panel) page. +- Legends are now displayed by default for time-series graphs on the [Cluster Overview]({% link cockroachcloud/overview-page.md %}#cluster-overview-metrics) page. +- The **Transaction retries** metric is no longer part of the **Current activity** panel on the CockroachDB {{ site.data.products.serverless }} [Cluster Overview]({% link cockroachcloud/overview-page.md %}#current-activity-panel) page. - Deleting an organization with outstanding charges that have not been billed is now prohibited. - There is now a more clear error message for users attempting to log into CockroachDB {{ site.data.products.cloud }} using GitHub when they have email and password authentication configured. -- Average RU usage is now shown in the **Request Units** chart for the CockroachDB {{ site.data.products.serverless }} [Cluster Overview]({% link cockroachcloud/cluster-overview-page.md %}#request-units) page. +- Average RU usage is now shown in the **Request Units** chart for the CockroachDB {{ site.data.products.serverless }} [Cluster Overview]({% link cockroachcloud/overview-page.md %}#request-units) page. - The PowerShell command to [download the CockroachDB binary](https://www.cockroachlabs.com/docs/cockroachcloud/connect-to-your-cluster?filters=windows#connect-to-your-cluster) is now improved for Windows users. -- When under 1 GiB of storage has been used, storage is now shown in MiB instead of GiB in the **Storage used** graph on the CockroachDB {{ site.data.products.serverless }} [Cluster Overview]({% link cockroachcloud/cluster-overview-page.md %}#storage-used) page. +- When under 1 GiB of storage has been used, storage is now shown in MiB instead of GiB in the **Storage used** graph on the CockroachDB {{ site.data.products.serverless }} [Cluster Overview]({% link cockroachcloud/overview-page.md %}#storage-used) page. - A more descriptive error message is now displayed when attempting to create or edit a [SQL user]({% link cockroachcloud/managing-access.md %}#manage-sql-users-on-a-cluster) with an invalid username. - Previously, clicking **cancel** while editing a cluster would take users back to the **Clusters** page. Now, users are taken back to the cluster's **Overview** page. @@ -1009,7 +1009,7 @@ For an in-depth explanation of CockroachDB {{ site.data.products.serverless }} p - Fixed a bug where, if a user had reached the maximum number of CockroachDB {{ site.data.products.serverless }} clusters and refreshed the **Create your cluster** page, the CockroachDB {{ site.data.products.serverless }} plan was auto-selected even though it is disabled. - Fixed a bug where clicking **Cancel** while logging in with GitHub would report and internal error. - Fixed a bug where organization deletion was temporarily broken. -- Fixed a bug that was preventing the **Request Units** and **SQL Statements** graphs on the CockroachDB {{ site.data.products.serverless }} [Cluster Overview]({% link cockroachcloud/cluster-overview-page.md %}#cluster-overview-metrics) page from updating after a certain amount of time. +- Fixed a bug that was preventing the **Request Units** and **SQL Statements** graphs on the CockroachDB {{ site.data.products.serverless }} [Cluster Overview]({% link cockroachcloud/overview-page.md %}#cluster-overview-metrics) page from updating after a certain amount of time. ## October 4, 2021 diff --git a/src/current/v25.1/monitor-and-analyze-transaction-contention.md b/src/current/v25.1/monitor-and-analyze-transaction-contention.md index fe5315166a5..0ffb1f1bcdd 100644 --- a/src/current/v25.1/monitor-and-analyze-transaction-contention.md +++ b/src/current/v25.1/monitor-and-analyze-transaction-contention.md @@ -22,7 +22,7 @@ The remaining sections address analyzing contention once identified: ## Monitor using Console -The [CockroachDB Cloud Console]({% link cockroachcloud/cluster-overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: +The [CockroachDB Cloud Console]({% link cockroachcloud/overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: - [SQL Statement Contention graph](#sql-statement-contention-graph) - [SQL Activity pages](#sql-activity-pages) diff --git a/src/current/v25.2/monitor-and-analyze-transaction-contention.md b/src/current/v25.2/monitor-and-analyze-transaction-contention.md index bb64dc6d370..575fb3debb2 100644 --- a/src/current/v25.2/monitor-and-analyze-transaction-contention.md +++ b/src/current/v25.2/monitor-and-analyze-transaction-contention.md @@ -22,7 +22,7 @@ The remaining sections address analyzing contention once identified: ## Monitor using Console -The [CockroachDB Cloud Console]({% link cockroachcloud/cluster-overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: +The [CockroachDB Cloud Console]({% link cockroachcloud/overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: - [SQL Statement Contention graph](#sql-statement-contention-graph) - [SQL Activity pages](#sql-activity-pages) diff --git a/src/current/v25.3/monitor-and-analyze-transaction-contention.md b/src/current/v25.3/monitor-and-analyze-transaction-contention.md index 7cbdb016fde..32584a23380 100644 --- a/src/current/v25.3/monitor-and-analyze-transaction-contention.md +++ b/src/current/v25.3/monitor-and-analyze-transaction-contention.md @@ -22,7 +22,7 @@ The remaining sections address analyzing contention once identified: ## Monitor using Console -The [CockroachDB Cloud Console]({% link cockroachcloud/cluster-overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: +The [CockroachDB Cloud Console]({% link cockroachcloud/overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: - [SQL Statement Contention graph](#sql-statement-contention-graph) - [SQL Activity pages](#sql-activity-pages) diff --git a/src/current/v25.4/monitor-and-analyze-transaction-contention.md b/src/current/v25.4/monitor-and-analyze-transaction-contention.md index 3e90b5e9074..9f504eb80c7 100644 --- a/src/current/v25.4/monitor-and-analyze-transaction-contention.md +++ b/src/current/v25.4/monitor-and-analyze-transaction-contention.md @@ -23,7 +23,7 @@ The remaining sections address analyzing contention once identified: ## Monitor using Console -The [CockroachDB Cloud Console]({% link cockroachcloud/cluster-overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: +The [CockroachDB Cloud Console]({% link cockroachcloud/overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: - [SQL Statement Contention graph](#sql-statement-contention-graph) - [SQL Activity pages](#sql-activity-pages) diff --git a/src/current/v26.1/monitor-and-analyze-transaction-contention.md b/src/current/v26.1/monitor-and-analyze-transaction-contention.md index e9751b3154b..0006f69f998 100644 --- a/src/current/v26.1/monitor-and-analyze-transaction-contention.md +++ b/src/current/v26.1/monitor-and-analyze-transaction-contention.md @@ -23,7 +23,7 @@ The remaining sections address analyzing contention once identified: ## Monitor using Console -The [CockroachDB Cloud Console]({% link cockroachcloud/cluster-overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: +The [CockroachDB Cloud Console]({% link cockroachcloud/overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: - [SQL Statement Contention graph](#sql-statement-contention-graph) - [SQL Activity pages](#sql-activity-pages) diff --git a/src/current/v26.2/monitor-and-analyze-transaction-contention.md b/src/current/v26.2/monitor-and-analyze-transaction-contention.md index 9a8bee8229f..7df2a876421 100644 --- a/src/current/v26.2/monitor-and-analyze-transaction-contention.md +++ b/src/current/v26.2/monitor-and-analyze-transaction-contention.md @@ -23,7 +23,7 @@ The remaining sections address analyzing contention once identified: ## Monitor using Console -The [CockroachDB Cloud Console]({% link cockroachcloud/cluster-overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: +The [CockroachDB Cloud Console]({% link cockroachcloud/overview-page.md %}) and [DB Console]({% link {{ page.version.version }}/ui-overview.md %}) provide monitoring of contention using the following features: - [SQL Statement Contention graph](#sql-statement-contention-graph) - [SQL Activity pages](#sql-activity-pages)