Skip to content

Clarify upgrade process for multi-node environments #39345

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
merged 3 commits into from
Jul 17, 2025
Merged

Clarify upgrade process for multi-node environments #39345

merged 3 commits into from
Jul 17, 2025
+1 −1

Conversation

Fuzzwah
Copy link
Contributor

@Fuzzwah Fuzzwah commented Jul 16, 2025 •
edited
Loading

Why:

The docs need to emphasise that the upgrade of the primary needs to fully complete before doing other nodes; trying to upgrade a replica will result in errors if the configuration run hasn't fully completed on the primary.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

@Fuzzwah
Clarify upgrade process for multi-node environments
3f5ad23 
emphasizing that the upgrade of the primary needs to fully complete before doing other nodes.
@Copilot Copilot AI review requested due to automatic review settings July 16, 2025 08:29
Copilot
Copilot AI reviewed Jul 16, 2025
View reviewed changes
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR clarifies the upgrade process for multi-node GitHub Enterprise Server environments by strengthening the language around the requirement to wait for the primary node upgrade to fully complete before upgrading other nodes. The change addresses a customer issue where attempting to upgrade replica nodes before the primary's configuration run was complete resulted in upgrade failures.

Key changes:

  • Enhanced guidance text for multi-node upgrade sequencing to emphasize waiting for configuration completion
  • Added explicit warning about upgrade failures when proper sequencing is not followed

...ent/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package.md Outdated
@@ -67,7 +67,7 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea
## Upgrading an instance with multiple nodes using an upgrade package

To upgrade an instance that comprises multiple nodes using an upgrade package, you must upgrade the primary node, then upgrade any additional nodes.
To upgrade a multi-node GitHub Enterprise Server environment using an upgrade package, you must first upgrade the primary node and wait for its configuration run to complete successfully. Only after the primary is fully upgraded and configured can you proceed to upgrade any replica or additional nodes. Attempting to upgrade other nodes before the primary is complete will result in upgrade failures.
Copy link
Preview

Copilot AI Jul 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The text 'GitHub Enterprise Server' should use the Liquid variable {% data variables.product.prodname_ghe_server %} instead of hardcoded text to ensure consistency and easier global updates.

Copilot uses AI. Check for mistakes.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 16, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jul 16, 2025 •
edited
Loading

How to review these changes 👓

Thank you for your contribution. To review these changes, choose one of the following options:

A Hubber will need to deploy your changes internally to review.

Table of review links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package.md ghes@ 3.17 3.16 3.15 3.14
ghes@ 3.17 3.16 3.15 3.14

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@Sharra-writes Sharra-writes added content This issue or pull request belongs to the Docs Content team administering a repo Content relating to administering a repo and removed triage Do not begin working on this issue until triaged by the team labels Jul 16, 2025
@Sharra-writes Sharra-writes added the waiting for review Issue/PR is waiting for a writer's review label Jul 16, 2025
vgrl
vgrl approved these changes Jul 17, 2025
View reviewed changes
Copy link
Contributor

@vgrl vgrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks for your contribution and keeping these docs updated! 🎉 I'll get this PR merged.

@vgrl vgrl added ready to merge This pull request is ready to merge and removed waiting for review Issue/PR is waiting for a writer's review labels Jul 17, 2025
@vgrl vgrl enabled auto-merge July 17, 2025 00:27
@vgrl vgrl added this pull request to the merge queue Jul 17, 2025
Merged via the queue into github:main with commit 493b8f8 Jul 17, 2025
41 checks passed
@github-actions GitHub Actions
Copy link
Contributor

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

Copilot code review Copilot Copilot left review comments

@Sharra-writes Sharra-writes Sharra-writes left review comments

@vgrl vgrl vgrl approved these changes

Assignees
No one assigned
Labels
administering a repo Content relating to administering a repo content This issue or pull request belongs to the Docs Content team ready to merge This pull request is ready to merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Fuzzwah @vgrl @Sharra-writes