Add callouts for S3-compatible storage support policy (#20503)

* Add callouts for S3-compatible storage support policy

* Alicia and Michael comments

* Strengthen support statement

Author: jhlodin

src/current/_includes/common/s3-support-notice.md

@@ -0,0 +1,14 @@
+{% if page.path contains "cockroachcloud" %}
+{{ 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.
+
+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_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 %}.
+
+
+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 %}

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).

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).

src/current/v24.1/backup.md

@@ -40,9 +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 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.**
-- 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_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
 

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).

src/current/v24.3/backup.md

@@ -40,9 +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 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.**
-- 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_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
 

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).

src/current/v25.2/backup.md

@@ -40,10 +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 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.**
-- 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_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}}

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).

src/current/v25.3/backup.md

@@ -40,10 +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 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.**
-- 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_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}}