Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/current/_data/redirects.yml
Original file line number Diff line number Diff line change
Expand Up @@ -1120,4 +1120,7 @@

- destination: reads-and-writes-overview.md
sources: ['query-data.md']
versions: ['v26.1', 'v26.2']
versions: ['v26.1', 'v26.2']

- destination: cockroachcloud/overview-page.md
sources: ['cockroachcloud/cluster-overview-page.md']
2 changes: 1 addition & 1 deletion src/current/_includes/cockroachcloud/request-units.md
Original file line number Diff line number Diff line change
@@ -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.
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.
4 changes: 2 additions & 2 deletions src/current/_includes/sidebar-data-cockroachcloud.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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"
]
},
{
Expand Down
36 changes: 20 additions & 16 deletions src/current/cockroachcloud/advanced-cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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.

Expand All @@ -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}}
Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -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.

Expand All @@ -176,16 +175,21 @@ 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 %})
- [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 %})

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

Expand All @@ -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**.
4 changes: 2 additions & 2 deletions src/current/cockroachcloud/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 %}).
Expand All @@ -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).
Expand Down
Loading
Loading