Skip to content

Commit 43a02fe

Browse files
djdefiCopilotCopilotmchammer01
authored
Clarify that ghe-check-background-upgrade-jobs gates feature upgrades, not replica progression (#61825)
Co-authored-by: Ryan Trauntvein <djdefi@users.noreply.github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: djdefi <3662109+djdefi@users.noreply.github.com> Co-authored-by: mc <42146119+mchammer01@users.noreply.github.com>
1 parent 64aa8e3 commit 43a02fe

2 files changed

Lines changed: 7 additions & 1 deletion

File tree

content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1384,12 +1384,15 @@ In this example, `ghe-repl-status -vv` sends verbose status information from a r
13841384
13851385
### ghe-check-background-upgrade-jobs
13861386
1387-
During an upgrade to a feature release, this utility displays the status of background jobs on {% data variables.location.product_location %}. If you're running back-to-back upgrades, you should use this utility to check that all background jobs are complete before proceeding with the next upgrade.
1387+
During an upgrade to a feature release, this utility displays the status of background upgrade jobs, such as Elasticsearch index migrations, on {% data variables.location.product_location %}. If you're running back-to-back upgrades, you should use this utility to check that all background jobs are complete before proceeding with the next feature upgrade.
13881388
13891389
```shell
13901390
ghe-check-background-upgrade-jobs
13911391
```
13921392
1393+
> [!NOTE]
1394+
> This utility only gates a **subsequent feature upgrade**. It is not a prerequisite for upgrading replica or other additional nodes to the same release.
1395+
13931396
### ghe-migrations
13941397
13951398
During an upgrade to a feature release, this utility displays the status of active database migrations on {% data variables.location.product_location %}. The output includes a version identifier for the migration, the migration's name, the migration's status, and the current duration of the migration.

content/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,9 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea
5353

5454
See [AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-check-background-upgrade-jobs).
5555

56+
> [!NOTE]
57+
> Background upgrade jobs only need to complete before you begin a subsequent feature upgrade. You don't need to wait for `ghe-check-background-upgrade-jobs` before upgrading replica or other additional nodes to the same release.
58+
5659
To monitor progress of the configuration run, read the output in `/data/user/common/ghe-config.log`. For example, you can tail the log by running the following command:
5760

5861
```shell

0 commit comments

Comments
 (0)