From 075e8d4d7550a9f69da0c763e203b69307d6556e Mon Sep 17 00:00:00 2001 From: Joe Lodin Date: Mon, 6 Oct 2025 13:49:32 -0400 Subject: [PATCH 1/3] Add callouts for S3-compatible storage support policy --- src/current/_includes/common/s3-support-notice.md | 13 +++++++++++++ .../cockroachcloud/backup-and-restore-overview.md | 2 ++ src/current/v24.1/backup-and-restore-overview.md | 15 +++++++++++---- src/current/v24.1/backup.md | 4 +++- src/current/v24.3/backup-and-restore-overview.md | 15 +++++++++++---- src/current/v24.3/backup.md | 4 +++- src/current/v25.2/backup-and-restore-overview.md | 15 +++++++++++---- src/current/v25.2/backup.md | 4 +++- src/current/v25.3/backup-and-restore-overview.md | 15 +++++++++++---- src/current/v25.3/backup.md | 4 +++- src/current/v25.4/backup-and-restore-overview.md | 15 +++++++++++---- src/current/v25.4/backup.md | 4 +++- 12 files changed, 85 insertions(+), 25 deletions(-) create mode 100644 src/current/_includes/common/s3-support-notice.md diff --git a/src/current/_includes/common/s3-support-notice.md b/src/current/_includes/common/s3-support-notice.md new file mode 100644 index 00000000000..8915bb90a53 --- /dev/null +++ b/src/current/_includes/common/s3-support-notice.md @@ -0,0 +1,13 @@ +{% if page.path contains "cockroachcloud" %} +{{ site.data.alerts.callout_info }} +Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. + +However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ site.current_cloud_version }}/support-resources.md %}) for more information. +{{ site.data.alerts.end }} +{% else %} +{{ site.data.alerts.callout_info }} +Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work{% if page.version.version !="v24.1" %}, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs{% endif %}. + +However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{page.version.version}}/support-resources.md %}) for more information. +{{ site.data.alerts.end }} +{% endif %} \ No newline at end of file diff --git a/src/current/cockroachcloud/backup-and-restore-overview.md b/src/current/cockroachcloud/backup-and-restore-overview.md index fe067a8f9b7..f48ee870027 100644 --- a/src/current/cockroachcloud/backup-and-restore-overview.md +++ b/src/current/cockroachcloud/backup-and-restore-overview.md @@ -81,6 +81,8 @@ We recommend taking backups to [cloud storage]({% link {{site.current_cloud_vers - [Example file URLs]({% link {{site.current_cloud_version}}/use-cloud-storage.md %}#example-file-urls) to form the URL that you pass to `BACKUP` and `RESTORE` statements. - [Authentication]({% link {{site.current_cloud_version}}/cloud-storage-authentication.md %}) to set up authentication to a cloud storage bucket and include those credentials in the URL. +{% include common/s3-support-notice.md %} + For detail on additional cloud storage features CockroachDB supports: - Prevent backups from being overwritten or deleted with [immutable storage buckets]({% link {{site.current_cloud_version}}/use-cloud-storage.md %}#immutable-storage). diff --git a/src/current/v24.1/backup-and-restore-overview.md b/src/current/v24.1/backup-and-restore-overview.md index b267ddbbfcf..18c32d11d64 100644 --- a/src/current/v24.1/backup-and-restore-overview.md +++ b/src/current/v24.1/backup-and-restore-overview.md @@ -7,10 +7,15 @@ docs_area: manage CockroachDB is built to be [fault-tolerant with automatic recovery]({% link {{ page.version.version }}/demo-fault-tolerance-and-recovery.md %}), but sometimes disasters happen. Backup and restore is an important part of a robust disaster recovery plan. CockroachDB {{ site.data.products.core }} clusters provide a range of [backup and restore features](#backup-and-restore-support). -- [Backup and restore product support](#backup-and-restore-support) -- [Schedules](#scheduled-backups) for periodic backups -- [SQL statements](#backup-and-restore-sql-statements) for working with backups and restores -- [Storage](#backup-storage) for backups +- [Backup and restore support](#backup-and-restore-support) + - [Additional backup and restore features](#additional-backup-and-restore-features) +- [Scheduled backups](#scheduled-backups) +- [Backup jobs with locality requirements](#backup-jobs-with-locality-requirements) +- [Backup and restore SQL statements](#backup-and-restore-sql-statements) +- [Backup storage](#backup-storage) +- [Backup and restore observability](#backup-and-restore-observability) +- [Video demo](#video-demo) +- [See also](#see-also) You can create full or incremental backups of a [cluster]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster), [database]({% link {{ page.version.version }}/backup.md %}#back-up-a-database), or [table]({% link {{ page.version.version }}/backup.md %}#back-up-a-table-or-view). Taking regular backups of your data is an operational best practice. @@ -130,6 +135,8 @@ We recommend taking backups to [cloud storage]({% link {{ page.version.version } - [Example file URLs]({% link {{ page.version.version }}/use-cloud-storage.md %}#example-file-urls) to form the URL that you pass to `BACKUP` and `RESTORE` statements. - [Authentication]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) to set up authentication to a cloud storage bucket and include those credentials in the URL. +{% include common/s3-support-notice.md %} + For detail on additional cloud storage features CockroachDB supports: - Prevent backups from being overwritten or deleted with [immutable storage buckets]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage). diff --git a/src/current/v24.1/backup.md b/src/current/v24.1/backup.md index 534fc92d0a3..8394ea03c4e 100644 --- a/src/current/v24.1/backup.md +++ b/src/current/v24.1/backup.md @@ -40,9 +40,11 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work. + + However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** -- While Cockroach Labs actively tests Amazon S3, Google Cloud Storage, and Azure Storage, we **do not** test [S3-compatible services]({% link {{ page.version.version }}/use-cloud-storage.md %}) (e.g., [MinIO](https://min.io/), [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/)). ## Required privileges diff --git a/src/current/v24.3/backup-and-restore-overview.md b/src/current/v24.3/backup-and-restore-overview.md index 139cb1269cd..de6e7e1a79c 100644 --- a/src/current/v24.3/backup-and-restore-overview.md +++ b/src/current/v24.3/backup-and-restore-overview.md @@ -7,10 +7,15 @@ docs_area: manage CockroachDB is built to be [fault-tolerant with automatic recovery]({% link {{ page.version.version }}/demo-cockroachdb-resilience.md %}), but sometimes disasters happen. Backup and restore is an important part of a robust disaster recovery plan. CockroachDB {{ site.data.products.core }} clusters provide a range of [backup and restore features](#backup-and-restore-support). -- [Backup and restore product support](#backup-and-restore-support) -- [Schedules](#scheduled-backups) for periodic backups -- [SQL statements](#backup-and-restore-sql-statements) for working with backups and restores -- [Storage](#backup-storage) for backups +- [Backup and restore support](#backup-and-restore-support) + - [Additional backup and restore features](#additional-backup-and-restore-features) +- [Scheduled backups](#scheduled-backups) +- [Backup jobs with locality requirements](#backup-jobs-with-locality-requirements) +- [Backup and restore SQL statements](#backup-and-restore-sql-statements) +- [Backup storage](#backup-storage) +- [Backup and restore observability](#backup-and-restore-observability) +- [Video demo](#video-demo) +- [See also](#see-also) You can create full or incremental backups of a [cluster]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster), [database]({% link {{ page.version.version }}/backup.md %}#back-up-a-database), or [table]({% link {{ page.version.version }}/backup.md %}#back-up-a-table-or-view). Taking regular backups of your data is an operational best practice. @@ -130,6 +135,8 @@ We recommend taking backups to [cloud storage]({% link {{ page.version.version } - [Example file URLs]({% link {{ page.version.version }}/use-cloud-storage.md %}#example-file-urls) to form the URL that you pass to `BACKUP` and `RESTORE` statements. - [Authentication]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) to set up authentication to a cloud storage bucket and include those credentials in the URL. +{% include common/s3-support-notice.md %} + For detail on additional cloud storage features CockroachDB supports: - Prevent backups from being overwritten or deleted with [immutable storage buckets]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage). diff --git a/src/current/v24.3/backup.md b/src/current/v24.3/backup.md index 1615765bdf6..945a516c500 100644 --- a/src/current/v24.3/backup.md +++ b/src/current/v24.3/backup.md @@ -40,9 +40,11 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. + + However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** -- While Cockroach Labs actively tests Amazon S3, Google Cloud Storage, and Azure Storage, we **do not** test [S3-compatible services]({% link {{ page.version.version }}/use-cloud-storage.md %}) (e.g., [MinIO](https://min.io/), [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/)). ## Required privileges diff --git a/src/current/v25.2/backup-and-restore-overview.md b/src/current/v25.2/backup-and-restore-overview.md index 139cb1269cd..de6e7e1a79c 100644 --- a/src/current/v25.2/backup-and-restore-overview.md +++ b/src/current/v25.2/backup-and-restore-overview.md @@ -7,10 +7,15 @@ docs_area: manage CockroachDB is built to be [fault-tolerant with automatic recovery]({% link {{ page.version.version }}/demo-cockroachdb-resilience.md %}), but sometimes disasters happen. Backup and restore is an important part of a robust disaster recovery plan. CockroachDB {{ site.data.products.core }} clusters provide a range of [backup and restore features](#backup-and-restore-support). -- [Backup and restore product support](#backup-and-restore-support) -- [Schedules](#scheduled-backups) for periodic backups -- [SQL statements](#backup-and-restore-sql-statements) for working with backups and restores -- [Storage](#backup-storage) for backups +- [Backup and restore support](#backup-and-restore-support) + - [Additional backup and restore features](#additional-backup-and-restore-features) +- [Scheduled backups](#scheduled-backups) +- [Backup jobs with locality requirements](#backup-jobs-with-locality-requirements) +- [Backup and restore SQL statements](#backup-and-restore-sql-statements) +- [Backup storage](#backup-storage) +- [Backup and restore observability](#backup-and-restore-observability) +- [Video demo](#video-demo) +- [See also](#see-also) You can create full or incremental backups of a [cluster]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster), [database]({% link {{ page.version.version }}/backup.md %}#back-up-a-database), or [table]({% link {{ page.version.version }}/backup.md %}#back-up-a-table-or-view). Taking regular backups of your data is an operational best practice. @@ -130,6 +135,8 @@ We recommend taking backups to [cloud storage]({% link {{ page.version.version } - [Example file URLs]({% link {{ page.version.version }}/use-cloud-storage.md %}#example-file-urls) to form the URL that you pass to `BACKUP` and `RESTORE` statements. - [Authentication]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) to set up authentication to a cloud storage bucket and include those credentials in the URL. +{% include common/s3-support-notice.md %} + For detail on additional cloud storage features CockroachDB supports: - Prevent backups from being overwritten or deleted with [immutable storage buckets]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage). diff --git a/src/current/v25.2/backup.md b/src/current/v25.2/backup.md index b93d5e3e8f6..62ce14482ed 100644 --- a/src/current/v25.2/backup.md +++ b/src/current/v25.2/backup.md @@ -40,9 +40,11 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. + + However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** -- While Cockroach Labs actively tests Amazon S3, Google Cloud Storage, and Azure Storage, we **do not** test [S3-compatible services]({% link {{ page.version.version }}/use-cloud-storage.md %}) (e.g., [MinIO](https://min.io/), [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/)). {{site.data.alerts.callout_success}} {% include {{ page.version.version }}/backups/external-storage-check-tip.md %} diff --git a/src/current/v25.3/backup-and-restore-overview.md b/src/current/v25.3/backup-and-restore-overview.md index 139cb1269cd..de6e7e1a79c 100644 --- a/src/current/v25.3/backup-and-restore-overview.md +++ b/src/current/v25.3/backup-and-restore-overview.md @@ -7,10 +7,15 @@ docs_area: manage CockroachDB is built to be [fault-tolerant with automatic recovery]({% link {{ page.version.version }}/demo-cockroachdb-resilience.md %}), but sometimes disasters happen. Backup and restore is an important part of a robust disaster recovery plan. CockroachDB {{ site.data.products.core }} clusters provide a range of [backup and restore features](#backup-and-restore-support). -- [Backup and restore product support](#backup-and-restore-support) -- [Schedules](#scheduled-backups) for periodic backups -- [SQL statements](#backup-and-restore-sql-statements) for working with backups and restores -- [Storage](#backup-storage) for backups +- [Backup and restore support](#backup-and-restore-support) + - [Additional backup and restore features](#additional-backup-and-restore-features) +- [Scheduled backups](#scheduled-backups) +- [Backup jobs with locality requirements](#backup-jobs-with-locality-requirements) +- [Backup and restore SQL statements](#backup-and-restore-sql-statements) +- [Backup storage](#backup-storage) +- [Backup and restore observability](#backup-and-restore-observability) +- [Video demo](#video-demo) +- [See also](#see-also) You can create full or incremental backups of a [cluster]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster), [database]({% link {{ page.version.version }}/backup.md %}#back-up-a-database), or [table]({% link {{ page.version.version }}/backup.md %}#back-up-a-table-or-view). Taking regular backups of your data is an operational best practice. @@ -130,6 +135,8 @@ We recommend taking backups to [cloud storage]({% link {{ page.version.version } - [Example file URLs]({% link {{ page.version.version }}/use-cloud-storage.md %}#example-file-urls) to form the URL that you pass to `BACKUP` and `RESTORE` statements. - [Authentication]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) to set up authentication to a cloud storage bucket and include those credentials in the URL. +{% include common/s3-support-notice.md %} + For detail on additional cloud storage features CockroachDB supports: - Prevent backups from being overwritten or deleted with [immutable storage buckets]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage). diff --git a/src/current/v25.3/backup.md b/src/current/v25.3/backup.md index b93d5e3e8f6..62ce14482ed 100644 --- a/src/current/v25.3/backup.md +++ b/src/current/v25.3/backup.md @@ -40,9 +40,11 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. + + However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** -- While Cockroach Labs actively tests Amazon S3, Google Cloud Storage, and Azure Storage, we **do not** test [S3-compatible services]({% link {{ page.version.version }}/use-cloud-storage.md %}) (e.g., [MinIO](https://min.io/), [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/)). {{site.data.alerts.callout_success}} {% include {{ page.version.version }}/backups/external-storage-check-tip.md %} diff --git a/src/current/v25.4/backup-and-restore-overview.md b/src/current/v25.4/backup-and-restore-overview.md index 139cb1269cd..de6e7e1a79c 100644 --- a/src/current/v25.4/backup-and-restore-overview.md +++ b/src/current/v25.4/backup-and-restore-overview.md @@ -7,10 +7,15 @@ docs_area: manage CockroachDB is built to be [fault-tolerant with automatic recovery]({% link {{ page.version.version }}/demo-cockroachdb-resilience.md %}), but sometimes disasters happen. Backup and restore is an important part of a robust disaster recovery plan. CockroachDB {{ site.data.products.core }} clusters provide a range of [backup and restore features](#backup-and-restore-support). -- [Backup and restore product support](#backup-and-restore-support) -- [Schedules](#scheduled-backups) for periodic backups -- [SQL statements](#backup-and-restore-sql-statements) for working with backups and restores -- [Storage](#backup-storage) for backups +- [Backup and restore support](#backup-and-restore-support) + - [Additional backup and restore features](#additional-backup-and-restore-features) +- [Scheduled backups](#scheduled-backups) +- [Backup jobs with locality requirements](#backup-jobs-with-locality-requirements) +- [Backup and restore SQL statements](#backup-and-restore-sql-statements) +- [Backup storage](#backup-storage) +- [Backup and restore observability](#backup-and-restore-observability) +- [Video demo](#video-demo) +- [See also](#see-also) You can create full or incremental backups of a [cluster]({% link {{ page.version.version }}/backup.md %}#back-up-a-cluster), [database]({% link {{ page.version.version }}/backup.md %}#back-up-a-database), or [table]({% link {{ page.version.version }}/backup.md %}#back-up-a-table-or-view). Taking regular backups of your data is an operational best practice. @@ -130,6 +135,8 @@ We recommend taking backups to [cloud storage]({% link {{ page.version.version } - [Example file URLs]({% link {{ page.version.version }}/use-cloud-storage.md %}#example-file-urls) to form the URL that you pass to `BACKUP` and `RESTORE` statements. - [Authentication]({% link {{ page.version.version }}/cloud-storage-authentication.md %}) to set up authentication to a cloud storage bucket and include those credentials in the URL. +{% include common/s3-support-notice.md %} + For detail on additional cloud storage features CockroachDB supports: - Prevent backups from being overwritten or deleted with [immutable storage buckets]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage). diff --git a/src/current/v25.4/backup.md b/src/current/v25.4/backup.md index b93d5e3e8f6..62ce14482ed 100644 --- a/src/current/v25.4/backup.md +++ b/src/current/v25.4/backup.md @@ -40,9 +40,11 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. + + However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** -- While Cockroach Labs actively tests Amazon S3, Google Cloud Storage, and Azure Storage, we **do not** test [S3-compatible services]({% link {{ page.version.version }}/use-cloud-storage.md %}) (e.g., [MinIO](https://min.io/), [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/)). {{site.data.alerts.callout_success}} {% include {{ page.version.version }}/backups/external-storage-check-tip.md %} From fe1475cdc67325e294d37c3d0b30c09b2c6c3cff Mon Sep 17 00:00:00 2001 From: Joe Lodin Date: Tue, 7 Oct 2025 17:04:37 -0400 Subject: [PATCH 2/3] Alicia and Michael comments --- src/current/_includes/common/s3-support-notice.md | 4 ++-- src/current/v24.1/backup.md | 4 ++-- src/current/v24.3/backup.md | 4 ++-- src/current/v25.2/backup.md | 4 ++-- src/current/v25.3/backup.md | 4 ++-- src/current/v25.4/backup.md | 4 ++-- 6 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/current/_includes/common/s3-support-notice.md b/src/current/_includes/common/s3-support-notice.md index 8915bb90a53..bdd007adc43 100644 --- a/src/current/_includes/common/s3-support-notice.md +++ b/src/current/_includes/common/s3-support-notice.md @@ -2,12 +2,12 @@ {{ site.data.alerts.callout_info }} Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. -However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ site.current_cloud_version }}/support-resources.md %}) for more information. +However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ site.current_cloud_version }}/support-resources.md %}) for more information. {{ site.data.alerts.end }} {% else %} {{ site.data.alerts.callout_info }} Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work{% if page.version.version !="v24.1" %}, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs{% endif %}. -However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{page.version.version}}/support-resources.md %}) for more information. +However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{page.version.version}}/support-resources.md %}) for more information. {{ site.data.alerts.end }} {% endif %} \ No newline at end of file diff --git a/src/current/v24.1/backup.md b/src/current/v24.1/backup.md index 8394ea03c4e..d7f0ddb989f 100644 --- a/src/current/v24.1/backup.md +++ b/src/current/v24.1/backup.md @@ -40,9 +40,9 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work. - However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. + However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** diff --git a/src/current/v24.3/backup.md b/src/current/v24.3/backup.md index 945a516c500..b939904a93a 100644 --- a/src/current/v24.3/backup.md +++ b/src/current/v24.3/backup.md @@ -40,9 +40,9 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. + However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** diff --git a/src/current/v25.2/backup.md b/src/current/v25.2/backup.md index 62ce14482ed..608d61820c0 100644 --- a/src/current/v25.2/backup.md +++ b/src/current/v25.2/backup.md @@ -40,9 +40,9 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. + However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** diff --git a/src/current/v25.3/backup.md b/src/current/v25.3/backup.md index 62ce14482ed..608d61820c0 100644 --- a/src/current/v25.3/backup.md +++ b/src/current/v25.3/backup.md @@ -40,9 +40,9 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. + However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** diff --git a/src/current/v25.4/backup.md b/src/current/v25.4/backup.md index 62ce14482ed..608d61820c0 100644 --- a/src/current/v25.4/backup.md +++ b/src/current/v25.4/backup.md @@ -40,9 +40,9 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions such as [MinIO](https://min.io/), or [Red Hat Ceph](https://docs.ceph.com/en/pacific/radosgw/s3/) may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - However, Cockroach Labs can only offer best-effort support for untested systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. + However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** From 0b78dfd5a2c4f5e1c220ba44c9f402eb97d79b51 Mon Sep 17 00:00:00 2001 From: Joe Lodin Date: Thu, 9 Oct 2025 11:55:33 -0400 Subject: [PATCH 3/3] Strengthen support statement --- src/current/_includes/common/s3-support-notice.md | 13 +++++++------ src/current/v24.1/backup.md | 8 +++++--- src/current/v24.3/backup.md | 8 +++++--- src/current/v25.2/backup.md | 7 ++++--- src/current/v25.3/backup.md | 7 ++++--- src/current/v25.4/backup.md | 7 ++++--- 6 files changed, 29 insertions(+), 21 deletions(-) diff --git a/src/current/_includes/common/s3-support-notice.md b/src/current/_includes/common/s3-support-notice.md index bdd007adc43..e19a7027cb0 100644 --- a/src/current/_includes/common/s3-support-notice.md +++ b/src/current/_includes/common/s3-support-notice.md @@ -1,13 +1,14 @@ {% if page.path contains "cockroachcloud" %} -{{ site.data.alerts.callout_info }} -Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. +{{ site.data.alerts.callout_danger }} +Cockroach Labs does not officially support S3-compatible storage solutions other than AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Some common compatibility issues may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. -However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ site.current_cloud_version }}/support-resources.md %}) for more information. +The [Cockroach Labs Support team]({% link {{ site.current_cloud_version }}/support-resources.md %}) is available to offer assistance where possible. If you encounter issues when using unsupported S3-compatible storage, drivers, or frameworks, contact the maintainer directly. {{ site.data.alerts.end }} {% else %} -{{ site.data.alerts.callout_info }} -Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work{% if page.version.version !="v24.1" %}, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs{% endif %}. +{{ site.data.alerts.callout_danger }} +Cockroach Labs does not officially support S3-compatible storage solutions other than AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage.{% if page.version.version !="v24.1" %} Some common compatibility issues may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs.{% endif %}. -However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{page.version.version}}/support-resources.md %}) for more information. + +The [Cockroach Labs Support team]({% link {{page.version.version}}/support-resources.md %}) is available to offer assistance where possible. If you encounter issues when using unsupported S3-compatible storage, drivers, or frameworks, contact the maintainer. {{ site.data.alerts.end }} {% endif %} \ No newline at end of file diff --git a/src/current/v24.1/backup.md b/src/current/v24.1/backup.md index d7f0ddb989f..e622c5cc8da 100644 --- a/src/current/v24.1/backup.md +++ b/src/current/v24.1/backup.md @@ -40,12 +40,14 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work. - - However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions are untested. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** +{{site.data.alerts.callout_danger}} +Cockroach Labs does not officially support untested storage systems. If you encounter issues when using unsupported S3-compatible storage, drivers, or frameworks, contact the maintainer. +{{site.data.alerts.end}} + ## Required privileges {% include {{ page.version.version }}/backups/updated-backup-privileges.md %} diff --git a/src/current/v24.3/backup.md b/src/current/v24.3/backup.md index b939904a93a..e51f7c26ea4 100644 --- a/src/current/v24.3/backup.md +++ b/src/current/v24.3/backup.md @@ -40,12 +40,14 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - - However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions are untested, but common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** +{{site.data.alerts.callout_danger}} +Cockroach Labs does not officially support untested storage systems. If you encounter issues when using unsupported S3-compatible storage, drivers, or frameworks, contact the maintainer. +{{site.data.alerts.end}} + ## Required privileges {% include {{ page.version.version }}/backups/updated-backup-privileges.md %} diff --git a/src/current/v25.2/backup.md b/src/current/v25.2/backup.md index 608d61820c0..725189f2e7d 100644 --- a/src/current/v25.2/backup.md +++ b/src/current/v25.2/backup.md @@ -40,12 +40,13 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - - However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions are untested, but common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** +{{site.data.alerts.callout_danger}} +Cockroach Labs does not officially support untested storage systems. If you encounter issues when using unsupported S3-compatible storage, drivers, or frameworks, contact the maintainer. +{{site.data.alerts.end}} {{site.data.alerts.callout_success}} {% include {{ page.version.version }}/backups/external-storage-check-tip.md %} {{site.data.alerts.end}} diff --git a/src/current/v25.3/backup.md b/src/current/v25.3/backup.md index 608d61820c0..725189f2e7d 100644 --- a/src/current/v25.3/backup.md +++ b/src/current/v25.3/backup.md @@ -40,12 +40,13 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - - However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions are untested, but common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** +{{site.data.alerts.callout_danger}} +Cockroach Labs does not officially support untested storage systems. If you encounter issues when using unsupported S3-compatible storage, drivers, or frameworks, contact the maintainer. +{{site.data.alerts.end}} {{site.data.alerts.callout_success}} {% include {{ page.version.version }}/backups/external-storage-check-tip.md %} {{site.data.alerts.end}} diff --git a/src/current/v25.4/backup.md b/src/current/v25.4/backup.md index 608d61820c0..725189f2e7d 100644 --- a/src/current/v25.4/backup.md +++ b/src/current/v25.4/backup.md @@ -40,12 +40,13 @@ To view the contents of an backup created with the `BACKUP` statement, use [`SHO ### Storage considerations -- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions may work, and common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - - However, Cockroach Labs does not support untested storage systems. Contact the [Cockroach Labs Support team]({% link {{ page.version.version}}/support-resources.md %}) for more information. +- Cockroach Labs tests functionality with AWS S3, Google Cloud Storage (GCS), and Azure Blob Storage. Other S3-compatible storage solutions are untested, but common compatibility issues in v24.3 and later may be fixed by adding the `AWS_SKIP_CHECKSUM` option to the S3 URLs. - [HTTP storage]({% link {{ page.version.version }}/use-a-local-file-server.md %}) is not supported for `BACKUP` and `RESTORE`. - Modifying backup files in the storage location could invalidate a backup, and therefore, prevent a restore. In v22.1 and later, **we recommend enabling [object locking]({% link {{ page.version.version }}/use-cloud-storage.md %}#immutable-storage) in your cloud storage bucket.** +{{site.data.alerts.callout_danger}} +Cockroach Labs does not officially support untested storage systems. If you encounter issues when using unsupported S3-compatible storage, drivers, or frameworks, contact the maintainer. +{{site.data.alerts.end}} {{site.data.alerts.callout_success}} {% include {{ page.version.version }}/backups/external-storage-check-tip.md %} {{site.data.alerts.end}}