Skip to content

Commit

Permalink
[DOC-7932][DOC-7933][DOC-7937] Document cluster-edit, horizontal and …
Browse files Browse the repository at this point in the history
…vertical scaling, storage scaling, upgrades, maintenance windows on Azure (#17368)

* [DOC-7933][DOC-7392][DOC-7937] Document cluster-edit, horizontal and vertical scaling support on Azure

---------

Co-authored-by: Gemma Shay <[email protected]>
  • Loading branch information
mdlinville and gemma-shay authored Sep 22, 2023
1 parent 7e71136 commit bb6bc05
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 20 deletions.
1 change: 1 addition & 0 deletions src/current/_data/cloud_releases.csv
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,4 @@ date,sha
2023-09-06,null
2023-09-08,null
2023-09-11,null
2023-09-22,null
5 changes: 5 additions & 0 deletions src/current/_includes/releases/cloud/2023-09-22.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
## September 22, 2023

<h3 id="2023-09-22-general-changes"> General changes </h3>

- CockroachDB {{ site.data.products.dedicated }} clusters on Azure can now be modified, [horizontally or vertically scaled]({% link cockroachcloud/cluster-management.md %}), [upgraded]({% link cockroachcloud/upgrade-policy.md %}), have their [storage increased]({% link cockroachcloud/cluster-management.md %})#increase-storage-for-a-cluster), and have [maintenance windows]({% link cockroachcloud/cluster-management.md %}#set-a-maintenance-window) set. To learn more, refer to [CockroachDB {{ site.data.products.dedicated }} on Azure]({% link cockroachcloud/cockroachdb-dedicated-on-azure.md %}).
22 changes: 10 additions & 12 deletions src/current/cockroachcloud/cluster-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ For each cluster, the following details display:
- [**Increase storage**](?filters=dedicated#increase-storage-for-a-cluster)
- [**Change compute**](?filters=dedicated#change-compute-for-a-cluster)
- [**Upgrade major version**]({% link cockroachcloud/upgrade-to-{{site.current_cloud_version}}.md %})
{% comment %} - [**Add/remove regions**](?filters=dedicated#add-or-remove-regions-from-a-cluster) {% endcomment %}
{% comment %}- [**Add/remove regions**](?filters=dedicated#add-or-remove-regions-from-a-cluster){% endcomment %}
- [**Delete cluster**](#delete-cluster)

To view and manage a specific cluster, click the name of the cluster. The [**Overview**](#view-cluster-overview) page will display.
Expand All @@ -51,9 +51,7 @@ From the **Overview** page, you can connect to your cluster. For more informatio

## Scale your cluster

{{site.data.alerts.callout_info}}
During [limited access](https://www.cockroachlabs.com/docs/{{ site.current_cloud_version }}/cockroachdb-feature-availability), CockroachDB {{ site.data.products.dedicated }} clusters on Azure cannot be scaled. Refer to [CockroachDB {{ site.data.products.dedicated }} on Azure]({% link cockroachcloud/cockroachdb-dedicated-on-azure.md %}).
{{site.data.alerts.end}}
These sections show how to scale a {{ site.data.products.dedicated }} cluster horizontally by adding or removing nodes or vertically by changing each node's storage and compute resources.

### Add or remove nodes from a cluster

Expand All @@ -78,6 +76,10 @@ To add or remove nodes from your cluster:

### Increase storage for a cluster

{{site.data.alerts.callout_info}}
During [limited access](/docs/{{site.versions["stable"]}}/cockroachdb-feature-availability.html), storage on {{ site.data.products.dedicated }} clusters on Azure cannot be scaled. Refer to [{{ site.data.products.dedicated }} on Azure](cockroachdb-dedicated-on-azure.html).
{{site.data.alerts.end}}

{{site.data.alerts.callout_danger}}
AWS disks can only be scaled once every six hours.
{{site.data.alerts.end}}
Expand Down Expand Up @@ -162,7 +164,7 @@ When you remove a region from a [multi-region]({% link cockroachcloud/plan-your-
1. In the **Confirmation** dialog, verify your new cluster configuration.
1. Click **OK**.
{% endcomment %}

## 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 upgrade window is set, your cluster will be automatically upgraded as soon as new patch versions are available. Refer to [Upgrade Policy]({% link cockroachcloud/upgrade-policy.md %}).
Expand All @@ -176,19 +178,15 @@ To set an upgrade window:
1. Click the pencil icon next to **Cluster maintenance** to edit the upgrade 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.

The window will last for 6 hours from the start time.

1. (Optional) If you want to delay automatic patch upgrades for 60 days, switch **Delay patch upgrades** to **On**.

Enable this setting for production clusters to ensure that development and testing clusters are upgraded before production clusters. This setting applies only to patch versions and not to other kinds of upgrades.

## Restore data from a backup

{{site.data.alerts.callout_info}}
During [limited access](https://www.cockroachlabs.com/docs/{{ site.current_cloud_version }}/cockroachdb-feature-availability), managed backups are not available for CockroachDB {{ site.data.products.dedicated }} clusters on Azure. Customers can [take and restore from their own backups on Azure storage]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}), including encrypted backups. Refer to [CockroachDB {{ site.data.products.dedicated }} on Azure]({% link cockroachcloud/cockroachdb-dedicated-on-azure.md %}).
{{site.data.alerts.end}}

Cockroach Labs runs full backups daily and incremental backups hourly for every CockroachDB {{ site.data.products.dedicated }} cluster. Full backups are retained for 30 days and incremental backups for 7 days. See the [Use Managed-Service Backups](use-managed-service-backups.html?filters=dedicated#ways-to-restore-data) page for ways to restore data from your cluster's automatic backups in the Console.

Additionally, you can [back up and restore]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}) your CockroachDB {{ site.data.products.dedicated }} cluster manually. For detail on taking backups to your cloud storage, see [Take and Restore Customer-Owned Backups]({% link cockroachcloud/take-and-restore-customer-owned-backups.md %}?filters=cloud#back-up-data).
Expand Down
13 changes: 5 additions & 8 deletions src/current/cockroachcloud/cockroachdb-dedicated-on-azure.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,8 @@ During [limited access](https://www.cockroachlabs.com/docs/{{ site.current_cloud
### Editing and scaling

- A cluster must have at minimum three nodes. Single-node clusters are not supported.
- After it is created, a cluster cannot yet be modified or scaled in place. Instead, create a new cluster with the desired configuration.

### Disaster recovery

- [Managed Service Backups]({% link cockroachcloud/use-managed-service-backups.md %}) are not yet available during the limited access period. Customers can take and restore from their own backups on Azure storage (Blob Storage or ADLS Gen 2).
- After it is created, a cluster's regions cannot yet be modified.
- After it is created, a cluster's storage can be increased in place, but cannot subsequently be decreased or removed.

### Networking

Expand Down Expand Up @@ -75,9 +72,9 @@ The clusters created during this period are recommended for proof-of-concept and

Yes.

### Is horizontal scaling supported?
### Are horizontal and vertical scaling supported?

Not yet.
Yes. Refer to [Cluster Management]({% link cockroachcloud/cluster-management.md %}).

### What Azure regions can we choose?

Expand Down Expand Up @@ -121,7 +118,7 @@ CockroachDB supports the [PostgreSQL wire protocol](https://www.postgresql.org/d

### How are clusters on Azure isolated from each other? Do they follow a similar approach as on AWS and GCP?

CockroachDB {{ site.data.products.cloud }} follows a similar tenant isolation approach on Azure as on GCP and AWS. During the limited access period, each {{ site.data.products.dedicated }} cluster is created on an [AKS cluster](https://azure.microsoft.com/products/kubernetes-service) in a unique [VNet](https://learn.microsoft.com/azure/virtual-network/virtual-networks-overview). Implementation details are subject to change.
CockroachDB {{ site.data.products.cloud }} follows a similar tenant isolation approach on Azure as on GCP and AWS. Each {{ site.data.products.dedicated }} cluster is created on an [AKS cluster](https://azure.microsoft.com/products/kubernetes-service) in a unique [VNet](https://learn.microsoft.com/azure/virtual-network/virtual-networks-overview). Implementation details are subject to change.

### Can we use Single-Sign On to sign-in to {{ site.data.products.db }} and manage clusters on Azure?

Expand Down

0 comments on commit bb6bc05

Please sign in to comment.