From 5b16250eaa0806bf9497756cb27c54a80f688eec Mon Sep 17 00:00:00 2001 From: Stoney <19228888+ThatStoney@users.noreply.github.com> Date: Fri, 18 Nov 2022 13:49:41 -0500 Subject: [PATCH] Clarify `ghe-upgrade-scheduler` uses and limitations (#32640) Co-authored-by: Laura Coursen --- .../configuring-your-enterprise/command-line-utilities.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index 7c9921bd9a..81e5573b49 100644 --- a/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -895,6 +895,8 @@ ghe-upgrade UPGRADE-PACKAGE-FILENAME This utility manages scheduled installation of upgrade packages. You can show, create new, or remove scheduled installations. You must create schedules using cron expressions. For more information, see the [Cron Wikipedia entry](https://en.wikipedia.org/wiki/Cron#Overview). +The `ghe-upgrade-scheduler` utility is best suited for scheduling hotpatch upgrades, which do not require maintenance mode or a reboot in most cases. This utility is not practical for full package upgrades, which require an administrator to manually set maintenance mode, reboot the instance, and unset maintenance mode. For more information about the different types of upgrades, see "[Upgrading {% data variables.product.product_name %}](/admin/enterprise-management/upgrading-github-enterprise-server#upgrading-with-an-upgrade-package)" + To schedule a new installation for a package: ```shell $ ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME