3.21.1 release

Author: release-controller[bot]

README.md

@@ -1,5 +1,13 @@
 # GitHub Enterprise Server Backup Utilities
 
+> [!IMPORTANT]
+> Did you mean: [Backup Service](https://github.com/github/ghes-backup-utils)?
+>
+> - `backup-utils` is the older backup solution for GHES. It provides a set of tools for a customer to copy data from their GHES appliance to an unrelated machine over SSH. These tools are not run on the appliance, but on the remote machine.
+> - `backup-service` is the newer solution. It is a service that runs on the GHES appliance itself and backs up data to a disk mounted at `/data/backup`.
+>
+> `backup-service` becomes GA in GHES 3.20 and is the preferred solution for backups. `backup-utils` will be deprecated in GHES 3.22.
+
 This repository includes backup and recovery utilities for
 [GitHub Enterprise Server][1].
 

docs/backup.config-example

@@ -117,7 +117,7 @@ GHE_NUM_SNAPSHOTS=10
 #GHE_PARALLEL_MAX_JOBS=2
 
 # Sets the maximum number of rsync jobs to run in parallel. Defaults to the
-# configured GHE_PARALLEL_MAX_JOBS, or the number of available processing 
+# configured GHE_PARALLEL_MAX_JOBS, or the number of available processing
 # units on the machine.
 #
 # GHE_PARALLEL_RSYNC_MAX_JOBS=3
@@ -138,3 +138,22 @@ GHE_NUM_SNAPSHOTS=10
 
 # If set to 'yes', Pages data will be included in backup and restore. Defaults to 'yes'
 #GHE_BACKUP_PAGES=no
+
+# Elasticsearch backup strategy. Valid values: 'rsync' or 'snapshot'
+# 'rsync' uses the traditional on-disk rsync method (default for backward compatibility)
+# 'snapshot' uses native Elasticsearch snapshots stored in customer-managed cloud storage
+#
+# Requirements for snapshot strategy:
+# - Configure the repository via ghe-config (for example, app.elasticsearch.backup.*)
+#   and apply it with ghe-config-apply on the appliance
+# - Repository name format: search_index_snapshots-{version} (e.g., search_index_snapshots-3.19.1)
+# - Supported storage types: S3 (repository-s3), Azure (repository-azure), Google Cloud Storage (repository-gcs)
+# - Backup-utils stores only snapshot metadata locally; snapshot contents remain in the configured repository
+#
+#GHE_ES_BACKUP_STRATEGY=snapshot
+
+# Snapshot naming prefix
+#GHE_ES_SNAPSHOT_NAME_PREFIX=snapshot
+
+# Elasticsearch snapshots always include cluster global state (templates, pipelines, data streams).
+# This setting is not configurable.