docs-bot
@@ -1455,7 +1455,7 @@ 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 "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-with-an-upgrade-package)"
|
||||
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 "[AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package)"
|
||||
|
||||
To schedule a new installation for a package:
|
||||
|
||||
|
||||
@@ -63,17 +63,19 @@ includeGuides:
|
||||
- /admin/administering-your-instance/administering-your-instance-from-the-web-ui
|
||||
- /admin/configuring-settings/hardening-security-for-your-enterprise/troubleshooting-tls-errors
|
||||
- /admin/configuring-settings/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/about-high-availability-configuration
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/accessing-the-monitor-dashboard
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/creating-a-high-availability-replica
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/differences-between-clustering-and-high-availability-ha
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/initiating-a-failover-to-your-replica-appliance
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/recommended-alert-thresholds
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/setting-up-external-monitoring
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrade-requirements
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/about-system-logs
|
||||
- /admin/monitoring-and-managing-your-instance/configuring-high-availability/about-high-availability-configuration
|
||||
- /admin/monitoring-and-managing-your-instance/monitoring-your-instance/accessing-the-monitor-dashboard
|
||||
- /admin/monitoring-and-managing-your-instance/configuring-high-availability/creating-a-high-availability-replica
|
||||
- /admin/monitoring-and-managing-your-instance/configuring-clustering/differences-between-clustering-and-high-availability-ha
|
||||
- /admin/upgrading-your-instance/preparing-to-upgrade/enabling-automatic-update-checks
|
||||
- /admin/monitoring-and-managing-your-instance/configuring-high-availability/initiating-a-failover-to-your-replica-appliance
|
||||
- /admin/monitoring-and-managing-your-instance/monitoring-your-instance/recommended-alert-thresholds
|
||||
- /admin/monitoring-and-managing-your-instance/monitoring-your-instance/setting-up-external-monitoring
|
||||
- /admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process
|
||||
- /admin/upgrading-your-instance/preparing-to-upgrade/upgrade-requirements
|
||||
- /admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot
|
||||
- /admin/upgrading-your-instance/performing-an-upgrade
|
||||
- /admin/monitoring-and-managing-your-instance/monitoring-your-instance/about-system-logs
|
||||
- /support/learning-about-github-support/about-github-support
|
||||
- /admin/managing-github-actions-for-your-enterprise/managing-access-to-actions-from-githubcom/about-using-actions-in-your-enterprise
|
||||
- /admin/managing-github-actions-for-your-enterprise/advanced-configuration-and-troubleshooting/backing-up-and-restoring-github-enterprise-server-with-github-actions-enabled
|
||||
|
||||
@@ -106,10 +106,11 @@ children:
|
||||
- /administering-your-instance
|
||||
- /managing-iam
|
||||
- /managing-accounts-and-repositories
|
||||
- /upgrading-your-instance
|
||||
- /backing-up-and-restoring-your-instance
|
||||
- /enforcing-policies
|
||||
- /monitoring-activity-in-your-enterprise
|
||||
- /monitoring-managing-and-updating-your-instance
|
||||
- /monitoring-and-managing-your-instance
|
||||
- /managing-github-actions-for-your-enterprise
|
||||
- /configuring-packages
|
||||
- /managing-code-security
|
||||
@@ -118,4 +119,3 @@ children:
|
||||
- /release-notes
|
||||
- /all-releases
|
||||
---
|
||||
|
||||
|
||||
@@ -8,6 +8,7 @@ topics:
|
||||
- Enterprise
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/caching-repositories/about-repository-caching
|
||||
- /admin/monitoring-managing-and-updating-your-instance/caching-repositories/about-repository-caching
|
||||
---
|
||||
|
||||
If you have teams and CI farms located around the world, you may experience reduced performance on your primary {% data variables.product.prodname_ghe_server %} instance. While active geo-replicas can improve the performance of read requests, this comes at the cost of limiting write throughput. To reduce load on your primary instance and improve write throughput performance, you can configure a repository cache, an asynchronous read-only mirror of repositories located near these geographically-distributed clients.
|
||||
@@ -8,6 +8,7 @@ topics:
|
||||
- Enterprise
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/caching-repositories/configuring-a-repository-cache
|
||||
- /admin/monitoring-managing-and-updating-your-instance/caching-repositories/configuring-a-repository-cache
|
||||
---
|
||||
|
||||
## About configuration for repository caching
|
||||
@@ -10,4 +10,6 @@ children:
|
||||
- /configuring-a-repository-cache
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/caching-repositories
|
||||
- /admin/monitoring-managing-and-updating-your-instance/caching-repositories
|
||||
---
|
||||
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/about-cluster-nodes
|
||||
- /admin/enterprise-management/about-cluster-nodes
|
||||
- /admin/enterprise-management/configuring-clustering/about-cluster-nodes
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/about-cluster-nodes
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: About clustering
|
||||
intro: "The cluster topology for {% data variables.product.prodname_ghe_server %} is designed to support tens of thousands of users where other topologies would experience resource exhaustion. In a cluster, the instance's services scale horizontally across multiple nodes."
|
||||
product: "{% data variables.product.company_short %} determines eligibility for clustering, and must enable the configuration for your instance's license. Clustering requires careful planning and additional administrative overhead."
|
||||
intro: 'The cluster topology for {% data variables.product.prodname_ghe_server %} is designed to support tens of thousands of users where other topologies would experience resource exhaustion. In a cluster, the instance''s services scale horizontally across multiple nodes.'
|
||||
product: '{% data variables.product.company_short %} determines eligibility for clustering, and must enable the configuration for your instance''s license. Clustering requires careful planning and additional administrative overhead.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/clustering/overview
|
||||
- /enterprise/admin/clustering/about-clustering
|
||||
@@ -9,6 +9,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/about-clustering
|
||||
- /admin/enterprise-management/about-clustering
|
||||
- /admin/enterprise-management/configuring-clustering/about-clustering
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/about-clustering
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/cluster-network-configuration
|
||||
- /admin/enterprise-management/cluster-network-configuration
|
||||
- /admin/enterprise-management/configuring-clustering/cluster-network-configuration
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/cluster-network-configuration
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: reference
|
||||
@@ -4,6 +4,7 @@ intro: 'You can configure a replica of your entire {% data variables.product.pro
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-management/configuring-high-availability-replication-for-a-cluster
|
||||
- /admin/enterprise-management/configuring-high-availability-replication-for-a-cluster
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/configuring-high-availability-replication-for-a-cluster
|
||||
versions:
|
||||
ghes: '>= 3.9'
|
||||
type: how_to
|
||||
@@ -8,6 +8,8 @@ type: how_to
|
||||
topics:
|
||||
- Clustering
|
||||
- Enterprise
|
||||
redirect_from:
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/deferring-database-seeding
|
||||
---
|
||||
|
||||
## About deferring database seeding of a MySQL replica node
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/differences-between-clustering-and-high-availability-ha
|
||||
- /admin/enterprise-management/differences-between-clustering-and-high-availability-ha
|
||||
- /admin/enterprise-management/configuring-clustering/differences-between-clustering-and-high-availability-ha
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/differences-between-clustering-and-high-availability-ha
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: reference
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Evacuating a cluster node running data services
|
||||
shortTitle: Evacuating a data node
|
||||
intro: If a node in your {% data variables.product.product_name %} cluster runs services that store distributed data, you can ensure redundancy as you prepare to replace the node by evacuating the node's data.
|
||||
intro: 'If a node in your {% data variables.product.product_name %} cluster runs services that store distributed data, you can ensure redundancy as you prepare to replace the node by evacuating the node''s data.'
|
||||
product: '{% data reusables.gated-features.cluster %}'
|
||||
redirect_from:
|
||||
- /enterprise/admin/clustering/evacuating-a-cluster-node
|
||||
@@ -9,8 +9,9 @@ redirect_from:
|
||||
- /admin/enterprise-management/evacuating-a-cluster-node
|
||||
- /admin/enterprise-management/configuring-clustering/evacuating-a-cluster-node
|
||||
- /admin/enterprise-management/configuring-clustering/evacuating-a-cluster-node-running-data-services
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/evacuating-a-cluster-node-running-data-services
|
||||
versions:
|
||||
ghes: '<=3.11'
|
||||
ghes: <=3.11
|
||||
type: how_to
|
||||
topics:
|
||||
- Clustering
|
||||
@@ -1,6 +1,6 @@
|
||||
---
|
||||
title: Configuring clustering
|
||||
intro: The cluster topology for {% data variables.product.product_name %} provides horizontal scaling for environments with tens of thousands of developers.
|
||||
intro: 'The cluster topology for {% data variables.product.product_name %} provides horizontal scaling for environments with tens of thousands of developers.'
|
||||
product: '{% data reusables.gated-features.cluster %}'
|
||||
redirect_from:
|
||||
- /enterprise/admin/clustering/setting-up-the-cluster-instances
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /enterprise/admin/guides/clustering/managing-a-github-enterprise-cluster
|
||||
- /enterprise/admin/enterprise-management/configuring-clustering
|
||||
- /admin/enterprise-management/configuring-clustering
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
@@ -28,3 +29,4 @@ children:
|
||||
- /configuring-high-availability-replication-for-a-cluster
|
||||
- /initiating-a-failover-to-your-replica-cluster
|
||||
---
|
||||
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/initializing-the-cluster
|
||||
- /admin/enterprise-management/initializing-the-cluster
|
||||
- /admin/enterprise-management/configuring-clustering/initializing-the-cluster
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/initializing-the-cluster
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -4,6 +4,7 @@ intro: 'If your {% data variables.product.prodname_ghe_server %} cluster fails,
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-cluster
|
||||
- /admin/enterprise-management/initiating-a-failover-to-your-replica-cluster
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/initiating-a-failover-to-your-replica-cluster
|
||||
versions:
|
||||
ghes: '>= 3.9'
|
||||
type: how_to
|
||||
@@ -1,11 +1,11 @@
|
||||
---
|
||||
title: Monitoring the health of your cluster nodes with Node Eligibility Service
|
||||
shortTitle: Node Eligibility Service
|
||||
intro: "You can monitor when nodes in a {% data variables.product.product_name %} cluster have been offline long enough to cause issues by using {% data variables.product.prodname_nes %}."
|
||||
permissions: People with administrative SSH access to a {% data variables.product.product_name %} instance can monitor cluster nodes.
|
||||
intro: 'You can monitor when nodes in a {% data variables.product.product_name %} cluster have been offline long enough to cause issues by using {% data variables.product.prodname_nes %}.'
|
||||
permissions: 'People with administrative SSH access to a {% data variables.product.product_name %} instance can monitor cluster nodes.'
|
||||
product: '{% data reusables.gated-features.cluster %}'
|
||||
versions:
|
||||
feature: 'node-eligibility-service'
|
||||
feature: node-eligibility-service
|
||||
type: how_to
|
||||
topics:
|
||||
- Clustering
|
||||
@@ -16,6 +16,7 @@ topics:
|
||||
- Performance
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster-nodes-with-node-eligibility-service
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/monitoring-the-health-of-your-cluster-nodes-with-node-eligibility-service
|
||||
---
|
||||
|
||||
## About {% data variables.product.prodname_nes %}
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Monitoring the health of your cluster
|
||||
shortTitle: Monitor cluster health
|
||||
intro: "To ensure the performance and redundancy of a {% data variables.product.product_name %} cluster, you can monitor the cluster's health."
|
||||
intro: 'To ensure the performance and redundancy of a {% data variables.product.product_name %} cluster, you can monitor the cluster''s health.'
|
||||
product: '{% data reusables.gated-features.cluster %}'
|
||||
redirect_from:
|
||||
- /enterprise/admin/clustering/monitoring-cluster-nodes
|
||||
@@ -9,6 +9,7 @@ redirect_from:
|
||||
- /admin/enterprise-management/monitoring-cluster-nodes
|
||||
- /admin/enterprise-management/configuring-clustering/monitoring-cluster-nodes
|
||||
- /admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/monitoring-the-health-of-your-cluster
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -1,17 +1,18 @@
|
||||
---
|
||||
title: Rebalancing cluster workloads
|
||||
shortTitle: Rebalance workloads
|
||||
intro: "You can force your {% data variables.product.product_name %} cluster to evenly distribute job allocations for workloads on the cluster's nodes."
|
||||
intro: 'You can force your {% data variables.product.product_name %} cluster to evenly distribute job allocations for workloads on the cluster''s nodes.'
|
||||
product: '{% data reusables.gated-features.cluster %}'
|
||||
permissions: People with administrative SSH access to a {% data variables.product.product_name %} instance can rebalance cluster workloads on the instance.
|
||||
permissions: 'People with administrative SSH access to a {% data variables.product.product_name %} instance can rebalance cluster workloads on the instance.'
|
||||
versions:
|
||||
feature: 'cluster-rebalancing'
|
||||
feature: cluster-rebalancing
|
||||
type: how_to
|
||||
topics:
|
||||
- Clustering
|
||||
- Enterprise
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/configuring-clustering/rebalancing-cluster-workloads
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/rebalancing-cluster-workloads
|
||||
---
|
||||
|
||||
## About workload balance for a {% data variables.product.product_name %} cluster
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/replacing-a-cluster-node
|
||||
- /admin/enterprise-management/replacing-a-cluster-node
|
||||
- /admin/enterprise-management/configuring-clustering/replacing-a-cluster-node
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/replacing-a-cluster-node
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -1,12 +1,13 @@
|
||||
---
|
||||
title: Upgrading a cluster
|
||||
intro: "To upgrade a {% data variables.product.prodname_ghe_server %} cluster to the latest release, use the administrative shell (SSH)."
|
||||
intro: 'To upgrade a {% data variables.product.prodname_ghe_server %} cluster to the latest release, use the administrative shell (SSH).'
|
||||
product: '{% data reusables.gated-features.cluster %}'
|
||||
redirect_from:
|
||||
- /enterprise/admin/clustering/upgrading-a-cluster
|
||||
- /enterprise/admin/enterprise-management/upgrading-a-cluster
|
||||
- /admin/enterprise-management/upgrading-a-cluster
|
||||
- /admin/enterprise-management/configuring-clustering/upgrading-a-cluster
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-clustering/upgrading-a-cluster
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/about-geo-replication
|
||||
- /admin/enterprise-management/about-geo-replication
|
||||
- /admin/enterprise-management/configuring-high-availability/about-geo-replication
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/about-geo-replication
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/about-high-availability-configuration
|
||||
- /admin/enterprise-management/about-high-availability-configuration
|
||||
- /admin/enterprise-management/configuring-high-availability/about-high-availability-configuration
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/about-high-availability-configuration
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/creating-a-high-availability-replica
|
||||
- /admin/enterprise-management/creating-a-high-availability-replica
|
||||
- /admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/creating-a-high-availability-replica
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /enterprise/admin/guides/installation/configuring-github-enterprise-for-high-availability
|
||||
- /enterprise/admin/enterprise-management/configuring-high-availability
|
||||
- /admin/enterprise-management/configuring-high-availability
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability
|
||||
intro: '{% data variables.product.prodname_ghe_server %} supports a high availability mode of operation designed to minimize service disruption in the event of hardware failure or major network outage affecting the primary appliance.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -22,3 +23,4 @@ children:
|
||||
- /about-geo-replication
|
||||
shortTitle: Configure high availability
|
||||
---
|
||||
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/initiating-a-failover-to-your-replica-appliance
|
||||
- /admin/enterprise-management/initiating-a-failover-to-your-replica-appliance
|
||||
- /admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/initiating-a-failover-to-your-replica-appliance
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -1,9 +1,9 @@
|
||||
---
|
||||
title: Monitoring a high-availability configuration
|
||||
intro: "After configuration of high availability for {% data variables.location.product_location %}, you can monitor the status of data replication among to your instance's replica nodes."
|
||||
intro: 'After configuration of high availability for {% data variables.location.product_location %}, you can monitor the status of data replication among to your instance''s replica nodes.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
permissions: Site administrators can monitor a high-availability configuration for a {% data variables.product.product_name %} instance.
|
||||
permissions: 'Site administrators can monitor a high-availability configuration for a {% data variables.product.product_name %} instance.'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
@@ -13,6 +13,7 @@ topics:
|
||||
shortTitle: Monitor HA configuration
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/configuring-high-availability/monitoring-a-high-availability-configuration
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/monitoring-a-high-availability-configuration
|
||||
---
|
||||
|
||||
## About observability for high availability
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/recovering-a-high-availability-configuration
|
||||
- /admin/enterprise-management/recovering-a-high-availability-configuration
|
||||
- /admin/enterprise-management/configuring-high-availability/recovering-a-high-availability-configuration
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/recovering-a-high-availability-configuration
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/removing-a-high-availability-replica
|
||||
- /admin/enterprise-management/removing-a-high-availability-replica
|
||||
- /admin/enterprise-management/configuring-high-availability/removing-a-high-availability-replica
|
||||
- /admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/removing-a-high-availability-replica
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -1,9 +1,10 @@
|
||||
---
|
||||
title: 'Monitoring, managing, and updating your instance'
|
||||
intro: 'You can monitor your instance, upgrade to a newer version, and configure clustering or high availability'
|
||||
title: 'Monitoring and managing your instance'
|
||||
intro: 'You can monitor your instance, update your virtual machine resources, and configure clustering or high availability, and repository caching.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/enterprise-management
|
||||
- /admin/enterprise-management
|
||||
- /admin/monitoring-managing-and-updating-your-instance
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
@@ -14,5 +15,5 @@ children:
|
||||
- /configuring-clustering
|
||||
- /configuring-high-availability
|
||||
- /caching-repositories
|
||||
shortTitle: 'Monitor, manage, and update your instance'
|
||||
shortTitle: 'Monitor and manage your instance'
|
||||
---
|
||||
@@ -12,6 +12,7 @@ topics:
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/monitoring-your-appliance/about-system-logs
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/about-system-logs
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/about-system-logs
|
||||
---
|
||||
|
||||
## About system logs for {% data variables.product.product_name %}
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /admin/enterprise-management/accessing-the-monitor-dashboard
|
||||
- /admin/enterprise-management/monitoring-your-appliance/accessing-the-monitor-dashboard
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/accessing-the-monitor-dashboard
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/accessing-the-monitor-dashboard
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: collectd metrics for GitHub Enterprise Server
|
||||
shortTitle: collectd metrics
|
||||
intro: "You can review the metrics that `collectd` gathers for {% data variables.location.product_location %}."
|
||||
intro: 'You can review the metrics that `collectd` gathers for {% data variables.location.product_location %}.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: reference
|
||||
@@ -11,6 +11,8 @@ topics:
|
||||
- Infrastructure
|
||||
- Monitoring
|
||||
- Performance
|
||||
redirect_from:
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/collectd-metrics-for-github-enterprise-server
|
||||
---
|
||||
|
||||
## About `collectd` metrics
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Configuring collectd for your instance
|
||||
shortTitle: Configure collectd
|
||||
intro: "To gain insight into {% data variables.product.product_name %}'s performance, you can review data from `collectd` on your instance, or optionally send the data to an external `collectd` server."
|
||||
intro: 'To gain insight into {% data variables.product.product_name %}''s performance, you can review data from `collectd` on your instance, or optionally send the data to an external `collectd` server.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/installation/configuring-collectd
|
||||
- /enterprise/admin/articles/configuring-collectd
|
||||
@@ -10,6 +10,7 @@ redirect_from:
|
||||
- /admin/enterprise-management/monitoring-your-appliance/configuring-collectd
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/configuring-collectd
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/configuring-collectd
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/configuring-collectd-for-your-instance
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -14,6 +14,7 @@ product: '{% data reusables.gated-features.generated-health-checks %}'
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/monitoring-your-appliance/generating-a-health-check-for-your-enterprise
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/generating-a-health-check-for-your-enterprise
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/generating-a-health-check-for-your-enterprise
|
||||
---
|
||||
|
||||
{% note %}
|
||||
@@ -8,6 +8,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/monitoring-your-appliance
|
||||
- /admin/enterprise-management/monitoring-your-appliance
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
@@ -23,3 +24,4 @@ children:
|
||||
- /generating-a-health-check-for-your-enterprise
|
||||
shortTitle: Monitor your instance
|
||||
---
|
||||
|
||||
@@ -6,8 +6,9 @@ redirect_from:
|
||||
- /enterprise/admin/articles/monitoring-using-snmp
|
||||
- /enterprise/admin/enterprise-management/monitoring-using-snmp
|
||||
- /admin/enterprise-management/monitoring-using-snmp
|
||||
- /admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp
|
||||
- /admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/monitoring-using-snmp
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/monitoring-using-snmp
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -9,6 +9,7 @@ redirect_from:
|
||||
- /admin/enterprise-management/recommended-alert-thresholds
|
||||
- /admin/enterprise-management/monitoring-your-appliance/recommended-alert-thresholds
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/recommended-alert-thresholds
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/recommended-alert-thresholds
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: reference
|
||||
@@ -7,6 +7,7 @@ redirect_from:
|
||||
- /admin/enterprise-management/setting-up-external-monitoring
|
||||
- /admin/enterprise-management/monitoring-your-appliance/setting-up-external-monitoring
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-appliance/setting-up-external-monitoring
|
||||
- /admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/setting-up-external-monitoring
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/increasing-cpu-or-memory-resources
|
||||
- /admin/enterprise-management/increasing-cpu-or-memory-resources
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-cpu-or-memory-resources
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -6,6 +6,7 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/increasing-storage-capacity
|
||||
- /admin/enterprise-management/increasing-storage-capacity
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -1,25 +1,20 @@
|
||||
---
|
||||
title: Updating the virtual machine and physical resources
|
||||
intro: 'Upgrading the virtual software and virtual hardware requires some downtime for your instance, so be sure to plan your upgrade in advance.'
|
||||
intro: 'Learn how to increase specific resources for the virtual machine that runs your {% data variables.product.product_name %} instance.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/guides/installation/upgrading-the-vm
|
||||
- /enterprise/admin/guides/installation/upgrading-physical-resources
|
||||
- /enterprise/admin/installation/updating-the-virtual-machine-and-physical-resources
|
||||
- /enterprise/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
children:
|
||||
- /upgrade-requirements
|
||||
- /upgrading-github-enterprise-server
|
||||
- /enabling-automatic-update-checks
|
||||
- /increasing-storage-capacity
|
||||
- /increasing-cpu-or-memory-resources
|
||||
- /migrating-from-github-enterprise-1110x-to-2123
|
||||
- /preparing-for-the-elasticsearch-upgrade
|
||||
- /using-generation-2-virtual-machines
|
||||
- /known-issues-with-upgrades-to-your-instance
|
||||
shortTitle: Update VM & resources
|
||||
---
|
||||
@@ -1,6 +1,8 @@
|
||||
---
|
||||
title: Using generation 2 virtual machines
|
||||
intro: 'New installs of {% data variables.product.prodname_ghe_server %} 3.14 or later can use generation 2 virtual machines.'
|
||||
redirect_from:
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/using-generation-2-virtual-machines
|
||||
versions:
|
||||
ghes: '>3.13'
|
||||
type: reference
|
||||
@@ -1,298 +0,0 @@
|
||||
---
|
||||
title: Upgrading GitHub Enterprise Server
|
||||
intro: 'Upgrade {% data variables.product.product_name %} to get the latest features and security updates.'
|
||||
permissions: 'Site administrators can upgrade a {% data variables.product.product_name %} instance.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/installation/upgrading-github-enterprise-server
|
||||
- /enterprise/admin/articles/upgrading-to-the-latest-release
|
||||
- /enterprise/admin/articles/migrations-and-upgrades
|
||||
- /enterprise/admin/guides/installation/upgrading-the-github-enterprise-virtual-machine
|
||||
- /enterprise/admin/guides/installation/upgrade-packages-for-older-releases
|
||||
- /enterprise/admin/articles/upgrading-older-installations
|
||||
- /enterprise/admin/hidden/upgrading-older-installations
|
||||
- /enterprise/admin/hidden/upgrading-github-enterprise-using-a-hotpatch-early-access-program
|
||||
- /enterprise/admin/hidden/upgrading-github-enterprise-using-a-hotpatch
|
||||
- /enterprise/admin/guides/installation/upgrading-github-enterprise
|
||||
- /enterprise/admin/enterprise-management/upgrading-github-enterprise-server
|
||||
- /admin/enterprise-management/upgrading-github-enterprise-server
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
shortTitle: Upgrading GHES
|
||||
---
|
||||
|
||||
## About upgrades to {% data variables.product.product_name %}
|
||||
|
||||
{% data reusables.enterprise.constantly-improving %} You are responsible for upgrades to your instance. For more information, see "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)."
|
||||
|
||||
To upgrade an instance, you must plan and communicate the upgrade, choose the appropriate package, back up your data, and then perform the upgrade.
|
||||
|
||||
> [!NOTE] Upgrading to a new feature release will cause a few hours of downtime, during which none of your users will be able to use the enterprise. You can inform your users about downtime by publishing a global announcement banner, using your enterprise settings or the REST API. See "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)" and "[AUTOTITLE](/rest/enterprise-admin#announcements)."
|
||||
|
||||
## Prerequisites
|
||||
|
||||
To successfully upgrade {% data variables.location.product_location %}, the instance's data disk must be at least 15% free. {% data variables.product.company_short %} recommends ensuring there is more free storage on the disk. In some rare cases, for customers with large data volumes, this threshold may differ.
|
||||
|
||||
{% data reusables.enterprise_installation.preflight-checks %}
|
||||
|
||||
## Preparing to upgrade
|
||||
|
||||
To prepare for an upgrade, plan the upgrade path, optionally upgrade {% data variables.product.prodname_actions %} runners, and schedule a maintenance window.
|
||||
|
||||
1. Determine an upgrade strategy and choose a version to upgrade to. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements)" and refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version.
|
||||
1. Create a fresh backup of your instance's primary node with the {% data variables.product.prodname_enterprise_backup_utilities %}. For more information, see the [README](https://github.com/github/backup-utils#readme) in the {% data variables.product.prodname_enterprise_backup_utilities %} project documentation.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Your {% data variables.product.prodname_enterprise_backup_utilities %} version needs to be the same version as, or at most two versions ahead of, {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/configuring-backups-on-your-appliance#upgrading-github-enterprise-server-backup-utilities)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
1. If {% data variables.location.product_location %} uses ephemeral self-hosted runners for {% data variables.product.prodname_actions %} and you've disabled automatic updates, upgrade your runners to the version of the runner application that your upgraded instance will run. To find the minimum required version for your release, see "[AUTOTITLE](/admin/all-releases#minimum-github-actions-runner-application-versions)."
|
||||
1. If you are upgrading using an upgrade package, schedule a maintenance window for {% data variables.product.prodname_ghe_server %} end users. If you are using a hotpatch, maintenance mode is not required.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** The maintenance window depends on the type of upgrade you perform. Upgrades using a hotpatch usually don't require a maintenance window. Sometimes a reboot is required, which you can perform at a later time. Following the versioning scheme of MAJOR.FEATURE.PATCH, patch releases using an upgrade package typically require less than five minutes of downtime. Feature releases that include data migrations take longer depending on storage performance and the amount of data that's migrated. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## Taking a snapshot
|
||||
|
||||
A snapshot stores the state of a virtual machine (VM) at a point in time. {% data variables.product.company_short %} highly recommends taking a snapshot before upgrading your VM so that if an upgrade fails, you can revert your VM back to the snapshot. {% data variables.product.company_short %} only recommends taking a VM snapshot when the instance's VM is powered down, or when the instance is in maintenance mode and all background jobs have finished.
|
||||
|
||||
If you're upgrading to a new feature release, you must take a VM snapshot. If you're upgrading to a patch release, you can attach the existing data disk.
|
||||
|
||||
There are two types of snapshots:
|
||||
|
||||
* **VM snapshots** save your entire VM state, including user data and configuration data. This snapshot method requires a large amount of disk space and is time consuming.
|
||||
* **Data disk snapshots** only save your user data.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Notes:**
|
||||
* Some platforms don't allow you to take a snapshot of just your data disk. For these platforms, you'll need to take a snapshot of the entire VM.
|
||||
* If your hypervisor does not support full VM snapshots, you should take a snapshot of the root disk and data disk in quick succession.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
| Platform | Snapshot method | Documentation |
|
||||
|---|---|---|
|
||||
| Amazon AWS | Disk | [Create Amazon EBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-snapshot.html) in the AWS documentation
|
||||
| Azure | VM | [Create a snaphot of a virtual hard disk on an Azure VM](https://learn.microsoft.com/azure/virtual-machines/snapshot-copy-managed-disk) in Microsoft Learn
|
||||
| Hyper-V | VM | [Enable or disable checkpoints in Hyper-V](https://docs.microsoft.com/windows-server/virtualization/hyper-v/manage/enable-or-disable-checkpoints-in-hyper-v) in Microsoft Learn
|
||||
| Google Compute Engine | Disk | [Create and manage disk snapshots](https://cloud.google.com/compute/docs/disks/create-snapshots) in the Google Cloud documentation
|
||||
| VMware | VM | [Taking Snapshots of a Virtual Machine](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.hostclient.doc/GUID-64B866EF-7636-401C-A8FF-2B4584D9CA72.html) in VMware Docs
|
||||
|
||||
## Choosing an upgrade package
|
||||
|
||||
You can upgrade a {% data variables.product.product_name %} instance to a new patch release or to a new feature release. To upgrade to a patch release, you can use a hotpatch or an upgrade package. To upgrade to a feature release, you must use an upgrade package.
|
||||
|
||||
A {% data variables.product.product_name %} instance comprises one or more nodes. The upgrade process you must follow depends on how many nodes your instance has. For more information, see "[AUTOTITLE](/admin/overview/about-github-enterprise-server#about-deployment-topologies)."
|
||||
|
||||
* [Upgrading with a hotpatch](#upgrading-with-a-hotpatch)
|
||||
* [Upgrading a standalone instance using a hotpatch](#upgrading-a-standalone-instance-using-a-hotpatch)
|
||||
* [Upgrading an instance with multiple nodes using a hotpatch](#upgrading-an-instance-with-multiple-nodes-using-a-hotpatch)
|
||||
* [Upgrading with an upgrade package](#upgrading-with-an-upgrade-package)
|
||||
* [Upgrading a standalone instance using an upgrade package](#upgrading-a-standalone-instance-using-an-upgrade-package)
|
||||
* [Upgrading an instance with multiple nodes using an upgrade package](#upgrading-an-instance-with-multiple-nodes-using-an-upgrade-package)
|
||||
|
||||
## Upgrading with a hotpatch
|
||||
|
||||
{% data reusables.enterprise_installation.hotpatching-explanation %}
|
||||
|
||||
Using the {% data variables.enterprise.management_console %}, you can install a hotpatch immediately or schedule it for later installation. You can use the administrative shell to install a hotpatch with the `ghe-upgrade` utility. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements)."
|
||||
|
||||
{% note %}
|
||||
|
||||
**Notes**:
|
||||
|
||||
* If {% data variables.location.product_location %} is running a release candidate build, you can't upgrade with a hotpatch.
|
||||
|
||||
* Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available for clusters. To install a hotpatch for a cluster, see "[AUTOTITLE](/admin/enterprise-management/configuring-clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
* [Upgrading a standalone instance using a hotpatch](#upgrading-a-standalone-instance-using-a-hotpatch)
|
||||
* [Upgrading an instance with multiple nodes using a hotpatch](#upgrading-an-instance-with-multiple-nodes-using-a-hotpatch)
|
||||
|
||||
### Upgrading a standalone instance using a hotpatch
|
||||
|
||||
If you're upgrading an instance with one node using a hotpatch, and your target is a patch release, you can upgrade using {% data variables.enterprise.management_console %}. To upgrade to a feature release, you must use the administrative shell.
|
||||
|
||||
* [Installing a hotpatch using the {% data variables.enterprise.management_console %}](#installing-a-hotpatch-using-the-management-console)
|
||||
* [Installing a hotpatch using the administrative shell](#installing-a-hotpatch-using-the-administrative-shell)
|
||||
|
||||
#### Installing a hotpatch using the {% data variables.enterprise.management_console %}
|
||||
|
||||
You can use the {% data variables.enterprise.management_console %} to upgrade with a hotpatch by enabling automatic updates. You will then be presented with the latest available version of {% data variables.product.prodname_ghe_server %} that you can upgrade to.
|
||||
|
||||
If the upgrade target you're presented with is a feature release instead of a patch release, you cannot use the {% data variables.enterprise.management_console %} to install a hotpatch. You must install the hotpatch using the administrative shell instead. For more information, see "[Installing a hotpatch using the administrative shell](#installing-a-hotpatch-using-the-administrative-shell)."
|
||||
|
||||
1. Enable automatic updates. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks)."
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.updates-tab %}
|
||||
1. When a new hotpatch has been downloaded, select the **Install package** dropdown menu.
|
||||
* To install immediately, click **Now**.
|
||||
* To install later, select a later date.
|
||||
1. Click **Install**.
|
||||
|
||||
#### Installing a hotpatch using the administrative shell
|
||||
|
||||
{% data reusables.enterprise_installation.download-note %}
|
||||
|
||||
{% data reusables.enterprise_installation.ssh-into-instance %}
|
||||
1. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} Copy the URL for the upgrade hotpackage (_.hpkg_ file).
|
||||
{% data reusables.enterprise_installation.download-package %}
|
||||
1. Run the `ghe-upgrade` command using the package file name:
|
||||
|
||||
```shell
|
||||
admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg
|
||||
*** verifying upgrade package signature...
|
||||
```
|
||||
|
||||
1. If at least one service or system component requires a reboot, the hotpatch upgrade script notifies you. For example, updates to the kernel, MySQL, or Elasticsearch may require a reboot.
|
||||
|
||||
### Upgrading an instance with multiple nodes using a hotpatch
|
||||
|
||||
If you are installing a hotpatch, you do not need to enter maintenance mode or stop replication.
|
||||
|
||||
* [Upgrading the primary node using a hotpatch](#upgrading-the-primary-node-using-a-hotpatch)
|
||||
* [Upgrading additional nodes using a hotpatch](#upgrading-additional-nodes-using-a-hotpatch)
|
||||
|
||||
#### Upgrading the primary node using a hotpatch
|
||||
|
||||
For instructions to upgrade the primary node, see "[Installing a hotpatch using the administrative shell](#installing-a-hotpatch-using-the-administrative-shell)."
|
||||
|
||||
#### Upgrading additional nodes using a hotpatch
|
||||
|
||||
{% data reusables.enterprise_installation.multiple-node-upgrade-admonishment %}
|
||||
|
||||
1. To upgrade the node, follow the instructions in "[Installing a hotpatch using the administrative shell](#installing-a-hotpatch-using-the-administrative-shell)."
|
||||
{% data reusables.enterprise_installation.replica-ssh %}
|
||||
{% data reusables.enterprise_installation.replica-verify %}
|
||||
{% data reusables.enterprise_installation.multiple-node-repeat-upgrade-process %}
|
||||
|
||||
## Upgrading with an upgrade package
|
||||
|
||||
While you can use a hotpatch to upgrade to the latest patch release within a feature series, you must use an upgrade package to upgrade to a newer feature release. For example to upgrade from 2.11.10 to 2.12.4 you must use an upgrade package since these are in different feature series. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements)."
|
||||
|
||||
* [Upgrading a standalone instance using an upgrade package](#upgrading-a-standalone-instance-using-an-upgrade-package)
|
||||
* [Upgrading an instance with multiple nodes using an upgrade package](#upgrading-an-instance-with-multiple-nodes-using-an-upgrade-package)
|
||||
|
||||
### Upgrading a standalone instance using an upgrade package
|
||||
|
||||
{% data reusables.enterprise_installation.download-note %}
|
||||
|
||||
{% data reusables.enterprise_installation.ssh-into-instance %}
|
||||
1. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} Select the appropriate platform and copy the URL for the upgrade package (_.pkg_ file).
|
||||
{% data reusables.enterprise_installation.download-package %}
|
||||
1. Enable maintenance mode and wait for all active processes to complete on the {% data variables.product.prodname_ghe_server %} instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: When upgrading the primary node in a high availability configuration, the instance should already be in maintenance mode if you are following the instructions in "[Upgrading the primary node with an upgrade package](#upgrading-the-primary-node-with-an-upgrade-package)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
1. Run the `ghe-upgrade` command using the package file name:
|
||||
|
||||
```shell
|
||||
admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg
|
||||
*** verifying upgrade package signature...
|
||||
```
|
||||
|
||||
1. Confirm that you'd like to continue with the upgrade and restart after the package signature verifies. The new root filesystem writes to the secondary partition and the instance automatically restarts in maintenance mode:
|
||||
|
||||
```shell
|
||||
*** applying update...
|
||||
This package will upgrade your installation to version VERSION-NUMBER
|
||||
Current root partition: /dev/xvda1 [VERSION-NUMBER]
|
||||
Target root partition: /dev/xvda2
|
||||
Proceed with installation? [y/N]
|
||||
```
|
||||
|
||||
{%- ifversion ghe-migrations-cli-utility %}
|
||||
1. Optionally, during an upgrade to a feature release, you can monitor the status of database migrations using the `ghe-migrations` utility. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-migrations)."
|
||||
{%- endif %}
|
||||
1. After the instance restarts, the upgrade will continue in the background. You cannot unset maintenance mode until the process completes.
|
||||
|
||||
{% ifversion ghes-upgrade-complete-indicator %}
|
||||
To check the status of background jobs, use the `ghe-check-background-upgrade-jobs` utility. If you're running back-to-back upgrades, you must ensure background jobs are complete before proceeding with the following upgrade to a feature release.
|
||||
|
||||
{%- ifversion ghes < 3.12 %} To use this utility with {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}, your instance must run version {{ allVersions[currentVersion].currentRelease }}.{% ifversion ghes = 3.10 %}4{% elsif ghes = 3.11 %}1{% endif %} or later.{% endif %}{%- endif %} For more information{% ifversion ghes < 3.12 %} about the utility{% endif %}, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-check-background-upgrade-jobs)."
|
||||
|
||||
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:
|
||||
|
||||
```shell
|
||||
tail -f /data/user/common/ghe-config.log
|
||||
```
|
||||
|
||||
{% ifversion ip-exception-list %}
|
||||
1. Optionally, after the upgrade, validate the upgrade by configuring an IP exception list to allow access to a specified list of IP addresses. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode#validating-changes-in-maintenance-mode-using-the-ip-exception-list)."
|
||||
{% endif %}
|
||||
1. For single node upgrades, disable maintenance mode so users can use {% data variables.location.product_location %}.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note**: After you upgrade an instance in a high availability configuration, you should remain in maintenance mode until you have upgraded all of the replica nodes and replication is current. For more information, see "[Upgrading additional nodes with an upgrade package](#upgrading-additional-nodes-with-an-upgrade-package)."
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### 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.
|
||||
|
||||
* [Upgrading the primary node with an upgrade package](#upgrading-the-primary-node-with-an-upgrade-package)
|
||||
* [Upgrading additional nodes with an upgrade package](#upgrading-additional-nodes-with-an-upgrade-package)
|
||||
|
||||
#### Upgrading the primary node with an upgrade package
|
||||
|
||||
{% warning %}
|
||||
|
||||
**Warning:** When replication is stopped, if the primary fails, any work that is done before the replica is upgraded and the replication begins again will be lost.
|
||||
|
||||
{% endwarning %}
|
||||
|
||||
1. On the primary node, enable maintenance mode and wait for all active processes to complete. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
{% data reusables.enterprise_installation.replica-ssh %}
|
||||
1. To stop replication on all nodes, run `ghe-repl-stop` on each node.{% ifversion ghes > 3.13 %} Alternatively, if there are mutliple replicas, run `ghe-repl-stop-all` on the primary node instead, which will stop replication in a single run.{% endif %}
|
||||
1. To upgrade the primary node, follow the instructions in "[Upgrading a standalone instance using an upgrade package](#upgrading-a-standalone-instance-using-an-upgrade-package)."
|
||||
|
||||
#### Upgrading additional nodes with an upgrade package
|
||||
|
||||
1. Upgrade the node by following the instructions in "[Upgrading a standalone instance using an upgrade package](#upgrading-a-standalone-instance-using-an-upgrade-package)."
|
||||
{% data reusables.enterprise_installation.replica-ssh %}
|
||||
{% data reusables.enterprise_installation.replica-verify %}
|
||||
{% data reusables.enterprise_installation.start-replication %}{% ifversion ghes > 3.13 %} Alternatively, if there are mutliple replicas, run `ghe-repl-start-all` on the primary node instead, which will start replications in a single run.{% endif %}
|
||||
{% data reusables.enterprise_installation.replication-status %} {% data reusables.enterprise_installation.replication-status-upgrade %}
|
||||
{% data reusables.enterprise_installation.multiple-node-repeat-upgrade-process %}
|
||||
{% data reusables.enterprise_installation.disable-maintenance-mode-after-replica-upgrade %}
|
||||
|
||||
## Restoring from a failed upgrade
|
||||
|
||||
If an upgrade fails or is interrupted, you should revert your instance back to its previous state. The process for completing this depends on the type of upgrade.
|
||||
|
||||
### Rolling back a patch release
|
||||
|
||||
To roll back a patch release, use the `ghe-upgrade` command with the `--allow-patch-rollback` switch. Before rolling back, replication must be temporarily stopped by running `ghe-repl-stop` on all replica nodes{% ifversion ghes > 3.13 %}, or `ghe-repl-stop-all` on the primary node{% endif %}. {% data reusables.enterprise_installation.command-line-utilities-ghe-upgrade-rollback %}
|
||||
|
||||
After the rollback is complete, restart replication by running `ghe-repl-start` on all nodes{% ifversion ghes > 3.13 %}, or `ghe-repl-start-all` on the primary node{% endif %}.
|
||||
|
||||
For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-upgrade)."
|
||||
|
||||
### Rolling back a feature release
|
||||
|
||||
To roll back from a feature release, restore from a VM snapshot to ensure that root and data partitions are in a consistent state. For more information, see "[Taking a snapshot](#taking-a-snapshot)."
|
||||
|
||||
{% ifversion ghes %}
|
||||
|
||||
## Further reading
|
||||
|
||||
* "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)"
|
||||
{% endif %}
|
||||
@@ -45,7 +45,7 @@ Between feature releases, you can benefit from patch releases, which:
|
||||
There are two ways to upgrade {% data variables.product.prodname_ghe_server %}:
|
||||
|
||||
* To set up a **completely new {% data variables.product.product_name %} instance** and configure the instance however you like, see "[AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance)" and "[AUTOTITLE](/admin/configuration/configuring-your-enterprise)."
|
||||
* To upgrade your **existing instance** to a new release, see "[AUTOTITLE](/enterprise-server@latest/admin/release-notes)" and "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)."
|
||||
* To upgrade your **existing instance** to a new release, see "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process)."
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
14
content/admin/upgrading-your-instance/index.md
Normal file
14
content/admin/upgrading-your-instance/index.md
Normal file
@@ -0,0 +1,14 @@
|
||||
---
|
||||
title: Upgrading your instance
|
||||
intro: 'Administrators can upgrade {% data variables.product.product_name %} to get the latest features and security updates.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
children:
|
||||
- /preparing-to-upgrade
|
||||
- /performing-an-upgrade
|
||||
- /troubleshooting-upgrades
|
||||
shortTitle: Upgrade your instance
|
||||
---
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Performing an upgrade
|
||||
intro: Administrators can upgrade {% data variables.product.product_name %} using an appropriate upgrade package.
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
children:
|
||||
- /upgrading-with-a-hotpatch
|
||||
- /upgrading-with-an-upgrade-package
|
||||
- /migrating-from-github-enterprise-1110x-to-2123
|
||||
- /preparing-for-the-elasticsearch-upgrade
|
||||
shortTitle: Perform an upgrade
|
||||
---
|
||||
@@ -11,6 +11,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123
|
||||
- /admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123
|
||||
- /admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/migrating-from-github-enterprise-1110x-to-2123
|
||||
intro: 'To migrate from {% data variables.product.prodname_enterprise %} 11.10.x to 2.1.23, you''ll need to set up a new appliance instance and migrate data from the previous instance.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
title: Preparing for the Elasticsearch upgrade in {% data variables.product.prodname_ghe_server %} 3.13
|
||||
title: 'Preparing for the Elasticsearch upgrade in {% data variables.product.prodname_ghe_server %} 3.13'
|
||||
intro: 'As part of upgrading {% data variables.product.prodname_ghe_server %} to version 3.13 or later, the Elasticsearch service will be upgraded.'
|
||||
versions:
|
||||
ghes: '>3.10 <3.15'
|
||||
@@ -9,6 +9,9 @@ topics:
|
||||
- Upgrades
|
||||
shortTitle: Elasticsearch upgrade in 3.13
|
||||
allowTitleToDifferFromFilename: true
|
||||
redirect_from:
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/preparing-for-the-elasticsearch-upgrade
|
||||
- /admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/preparing-for-the-elasticsearch-upgrade
|
||||
---
|
||||
|
||||
## Overview
|
||||
@@ -0,0 +1,76 @@
|
||||
---
|
||||
title: Upgrading with a hotpatch
|
||||
intro: 'You can use a hotpatch package to upgrade {% data variables.product.product_name %} to a newer patch release within a feature series.'
|
||||
redirect_from:
|
||||
- /admin/guides/installation/upgrading-github-enterprise-server#upgrading-with-a-hotpatch
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-with-a-hotpatch
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
shortTitle: Upgrade with a hotpatch
|
||||
---
|
||||
|
||||
{% data reusables.enterprise_installation.hotpatching-explanation %}
|
||||
|
||||
Using the {% data variables.enterprise.management_console %}, you can install a hotpatch immediately or schedule it for later installation. You can use the administrative shell to install a hotpatch with the `ghe-upgrade` utility. See "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process)" and "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements)."
|
||||
|
||||
## Upgrading a standalone instance using a hotpatch
|
||||
|
||||
If you're upgrading an instance with one node using a hotpatch, and your target is a patch release, you can upgrade using {% data variables.enterprise.management_console %}. To upgrade to a feature release, you must use the administrative shell.
|
||||
|
||||
* [Installing a hotpatch using the {% data variables.enterprise.management_console %}](#installing-a-hotpatch-using-the-management-console)
|
||||
* [Installing a hotpatch using the administrative shell](#installing-a-hotpatch-using-the-administrative-shell)
|
||||
|
||||
### Installing a hotpatch using the {% data variables.enterprise.management_console %}
|
||||
|
||||
You can use the {% data variables.enterprise.management_console %} to upgrade with a hotpatch by enabling automatic updates. You will then be presented with the latest available version of {% data variables.product.prodname_ghe_server %} that you can upgrade to.
|
||||
|
||||
If the upgrade target you're presented with is a feature release instead of a patch release, you cannot use the {% data variables.enterprise.management_console %} to install a hotpatch. You must install the hotpatch using the administrative shell instead.
|
||||
|
||||
1. Enable automatic updates. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks)."
|
||||
{% data reusables.enterprise_site_admin_settings.access-settings %}
|
||||
{% data reusables.enterprise_site_admin_settings.management-console %}
|
||||
{% data reusables.enterprise_management_console.updates-tab %}
|
||||
1. When a new hotpatch has been downloaded, select the **Install package** dropdown menu.
|
||||
* To install immediately, click **Now**.
|
||||
* To install later, select a later date.
|
||||
1. Click **Install**.
|
||||
|
||||
### Installing a hotpatch using the administrative shell
|
||||
|
||||
{% data reusables.enterprise_installation.download-note %}
|
||||
|
||||
{% data reusables.enterprise_installation.ssh-into-instance %}
|
||||
1. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} Copy the URL for the upgrade hotpackage (_.hpkg_ file).
|
||||
{% data reusables.enterprise_installation.download-package %}
|
||||
1. Run the `ghe-upgrade` command using the package file name:
|
||||
|
||||
```shell
|
||||
admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg
|
||||
*** verifying upgrade package signature...
|
||||
```
|
||||
|
||||
1. If at least one service or system component requires a reboot, the hotpatch upgrade script notifies you. For example, updates to the kernel, MySQL, or Elasticsearch may require a reboot.
|
||||
|
||||
## Upgrading an instance with multiple nodes using a hotpatch
|
||||
|
||||
If you are installing a hotpatch, you do not need to enter maintenance mode or stop replication.
|
||||
|
||||
* [Upgrading the primary node using a hotpatch](#upgrading-the-primary-node-using-a-hotpatch)
|
||||
* [Upgrading additional nodes using a hotpatch](#upgrading-additional-nodes-using-a-hotpatch)
|
||||
|
||||
### Upgrading the primary node using a hotpatch
|
||||
|
||||
For instructions to upgrade the primary node, see "[Installing a hotpatch using the administrative shell](#installing-a-hotpatch-using-the-administrative-shell)."
|
||||
|
||||
### Upgrading additional nodes using a hotpatch
|
||||
|
||||
{% data reusables.enterprise_installation.multiple-node-upgrade-admonishment %}
|
||||
|
||||
1. To upgrade the node, follow the instructions in "[Installing a hotpatch using the administrative shell](#installing-a-hotpatch-using-the-administrative-shell)."
|
||||
{% data reusables.enterprise_installation.replica-ssh %}
|
||||
{% data reusables.enterprise_installation.replica-verify %}
|
||||
{% data reusables.enterprise_installation.multiple-node-repeat-upgrade-process %}
|
||||
@@ -0,0 +1,97 @@
|
||||
---
|
||||
title: Upgrading with an upgrade package
|
||||
intro: 'Learn how to use an upgrade package to upgrade {% data variables.product.product_name %} to a newer feature release.'
|
||||
redirect_from:
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-a-standalone-instance-using-an-upgrade-package
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-with-an-upgrade-package
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
shortTitle: Upgrade with an upgrade package
|
||||
---
|
||||
|
||||
Using the administrative shell, you can install an upgrade package with the `ghe-upgrade` utility.
|
||||
|
||||
If you're running back-to-back feature version upgrades, you must ensure background jobs are complete before proceeding with the following upgrade to a feature release. {% data variables.product.prodname_dotcom %} recommends waiting 24 hours between upgrades to allow any background upgrade tasks to complete before upgrading a second time. See "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process)" and "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements)."
|
||||
|
||||
While you can use a hotpatch to upgrade to the latest patch release within a feature series, you must use an upgrade package to upgrade to a newer feature release. For example, to upgrade from 2.11.10 to 2.12.4 you must use an upgrade package since these are in different feature series.
|
||||
|
||||
## Upgrading a standalone instance using an upgrade package
|
||||
|
||||
{% data reusables.enterprise_installation.download-note %}
|
||||
|
||||
{% data reusables.enterprise_installation.ssh-into-instance %}
|
||||
1. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} Select the appropriate platform and copy the URL for the upgrade package (_.pkg_ file).
|
||||
{% data reusables.enterprise_installation.download-package %}
|
||||
1. Enable maintenance mode and wait for all active processes to complete on the {% data variables.product.prodname_ghe_server %} instance. See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
|
||||
> [!NOTE] When upgrading the primary node in a high availability configuration, the instance should already be in maintenance mode if you are following the instructions in "[Upgrading the primary node with an upgrade package](#upgrading-the-primary-node-with-an-upgrade-package)."
|
||||
|
||||
1. Run the `ghe-upgrade` command using the package file name:
|
||||
|
||||
```shell
|
||||
admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg
|
||||
*** verifying upgrade package signature...
|
||||
```
|
||||
|
||||
1. Confirm that you'd like to continue with the upgrade and restart after the package signature verifies. The new root filesystem writes to the secondary partition and the instance automatically restarts in maintenance mode:
|
||||
|
||||
```shell
|
||||
*** applying update...
|
||||
This package will upgrade your installation to version VERSION-NUMBER
|
||||
Current root partition: /dev/xvda1 [VERSION-NUMBER]
|
||||
Target root partition: /dev/xvda2
|
||||
Proceed with installation? [y/N]
|
||||
```
|
||||
|
||||
{%- ifversion ghe-migrations-cli-utility %}
|
||||
1. Optionally, during an upgrade to a feature release, you can monitor the status of database migrations using the `ghe-migrations` utility. See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-migrations)."
|
||||
{%- endif %}
|
||||
1. After the instance restarts, the upgrade will continue in the background. You cannot unset maintenance mode until the process completes.
|
||||
|
||||
{% ifversion ghes-upgrade-complete-indicator %}
|
||||
To check the status of background jobs, use the `ghe-check-background-upgrade-jobs` utility. If you're running back-to-back upgrades, you must ensure background jobs are complete before proceeding with the following upgrade to a feature release.
|
||||
|
||||
{%- ifversion ghes < 3.12 %} To use this utility with {% data variables.product.product_name %} {{ allVersions[currentVersion].currentRelease }}, your instance must run version {{ allVersions[currentVersion].currentRelease }}.{% ifversion ghes = 3.9 %}7{% elsif ghes = 3.10 %}4{% elsif ghes = 3.11 %}1{% endif %} or later.{% endif %}{%- endif %} See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-check-background-upgrade-jobs)."
|
||||
|
||||
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:
|
||||
|
||||
```shell
|
||||
tail -f /data/user/common/ghe-config.log
|
||||
```
|
||||
|
||||
{% ifversion ip-exception-list %}
|
||||
1. Optionally, after the upgrade, validate the upgrade by configuring an IP exception list to allow access to a specified list of IP addresses. See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode#validating-changes-in-maintenance-mode-using-the-ip-exception-list)."
|
||||
{% endif %}
|
||||
1. For single node upgrades, perform any post-upgrade tasks including disabling maintenance mode so users can use {% data variables.location.product_location %}.
|
||||
|
||||
> [!NOTE] After you upgrade an instance in a high availability configuration, you should remain in maintenance mode until you have upgraded all of the replica nodes and replication is current. See "[Upgrading additional nodes with an upgrade package](#upgrading-additional-nodes-with-an-upgrade-package)."
|
||||
|
||||
## 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.
|
||||
|
||||
* [Upgrading the primary node with an upgrade package](#upgrading-the-primary-node-with-an-upgrade-package)
|
||||
* [Upgrading additional nodes with an upgrade package](#upgrading-additional-nodes-with-an-upgrade-package)
|
||||
|
||||
### Upgrading the primary node with an upgrade package
|
||||
|
||||
> [!WARNING] When replication is stopped, if the primary fails, any work from before the replica is upgraded and the replication begins again will be lost.
|
||||
|
||||
1. On the primary node, enable maintenance mode and wait for all active processes to complete. See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
{% data reusables.enterprise_installation.replica-ssh %}
|
||||
1. To stop replication on all nodes, run `ghe-repl-stop` on each node.{% ifversion ghes > 3.13 %} Alternatively, if there are multiple replicas, run `ghe-repl-stop-all` on the primary node instead, which will stop replication in a single run.{% endif %}
|
||||
1. To upgrade the primary node, follow the instructions in "[Upgrading a standalone instance using an upgrade package](#upgrading-a-standalone-instance-using-an-upgrade-package)."
|
||||
|
||||
### Upgrading additional nodes with an upgrade package
|
||||
|
||||
1. Upgrade the node by following the instructions in "[Upgrading a standalone instance using an upgrade package](#upgrading-a-standalone-instance-using-an-upgrade-package)."
|
||||
{% data reusables.enterprise_installation.replica-ssh %}
|
||||
{% data reusables.enterprise_installation.replica-verify %}
|
||||
{% data reusables.enterprise_installation.start-replication %}{% ifversion ghes > 3.13 %} Alternatively, if there are mutliple replicas, run `ghe-repl-start-all` on the primary node instead, which will start replications in a single run.{% endif %}
|
||||
{% data reusables.enterprise_installation.replication-status %} {% data reusables.enterprise_installation.replication-status-upgrade %}
|
||||
{% data reusables.enterprise_installation.multiple-node-repeat-upgrade-process %}
|
||||
{% data reusables.enterprise_installation.disable-maintenance-mode-after-replica-upgrade %}
|
||||
@@ -6,6 +6,8 @@ redirect_from:
|
||||
- /enterprise/admin/enterprise-management/enabling-automatic-update-checks
|
||||
- /admin/enterprise-management/enabling-automatic-update-checks
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks
|
||||
- /admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
@@ -17,9 +19,9 @@ shortTitle: Enable automatic update checks
|
||||
|
||||
## About automatic update checks
|
||||
|
||||
When an upgrade package is automatically downloaded for {% data variables.location.product_location %}, you'll receive a message letting you know you can upgrade {% data variables.product.prodname_ghe_server %}. Packages download to the `/var/lib/ghe-updates` directory on {% data variables.location.product_location %}. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)."
|
||||
When an upgrade package is automatically downloaded for {% data variables.location.product_location %}, you'll receive a message letting you know you can upgrade {% data variables.product.prodname_ghe_server %}. Packages download to the `/var/lib/ghe-updates` directory on {% data variables.location.product_location %}. For more information about the recommendations and requirements for upgrades, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server)."
|
||||
|
||||
If a hotpatch is available for an upgrade, the `.hpkg` will download automatically. In the management console you can choose to install the hotpatch immediately or schedule installation for a later time. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-with-a-hotpatch)."
|
||||
If a hotpatch is available for an upgrade, the `.hpkg` will download automatically. In the management console you can choose to install the hotpatch immediately or schedule installation for a later time. For more information, see "[AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-a-hotpatch)."
|
||||
|
||||
## Enabling automatic update checks
|
||||
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Preparing to upgrade
|
||||
intro: Learn how to prepare and plan for an upgrade of your {% data variables.product.product_name %} instance.
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
children:
|
||||
- /overview-of-the-upgrade-process
|
||||
- /upgrade-requirements
|
||||
- /enabling-automatic-update-checks
|
||||
- /taking-a-snapshot
|
||||
shortTitle: Prepare to upgrade
|
||||
---
|
||||
@@ -0,0 +1,122 @@
|
||||
---
|
||||
title: Overview of the upgrade process
|
||||
intro: 'Learn the recommendations and requirements for upgrading {% data variables.product.product_name %}, so you can plan and test your upgrade strategy.'
|
||||
redirect_from:
|
||||
- /enterprise/admin/installation/upgrading-github-enterprise-server
|
||||
- /enterprise/admin/articles/upgrading-to-the-latest-release
|
||||
- /enterprise/admin/articles/migrations-and-upgrades
|
||||
- /enterprise/admin/guides/installation/upgrading-the-github-enterprise-virtual-machine
|
||||
- /enterprise/admin/guides/installation/upgrade-packages-for-older-releases
|
||||
- /enterprise/admin/articles/upgrading-older-installations
|
||||
- /enterprise/admin/hidden/upgrading-older-installations
|
||||
- /enterprise/admin/hidden/upgrading-github-enterprise-using-a-hotpatch-early-access-program
|
||||
- /enterprise/admin/hidden/upgrading-github-enterprise-using-a-hotpatch
|
||||
- /enterprise/admin/guides/installation/upgrading-github-enterprise
|
||||
- /enterprise/admin/enterprise-management/upgrading-github-enterprise-server
|
||||
- /admin/enterprise-management/upgrading-github-enterprise-server
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
shortTitle: Upgrading overview
|
||||
---
|
||||
|
||||
{% data reusables.enterprise.constantly-improving %} You are responsible for upgrades to your instance. See "[AUTOTITLE](/admin/overview/about-upgrades-to-new-releases)."
|
||||
|
||||
To upgrade an instance, you must:
|
||||
1. **Plan your upgrade strategy** by choosing your upgrade version and the appropriate upgrade package, and scheduling a maintenance window.
|
||||
1. **Communicate the upgrade** before and during the upgrade process.
|
||||
1. **Prepare your backup strategy** by creating a backup and taking a virtual machine snapshot.
|
||||
1. **Install the upgrade package** using the appropriate package and method.
|
||||
1. **Complete post-upgrade tasks**.
|
||||
|
||||
The process you must follow to apply an upgrade package depends on how many nodes are in your deployment topology. This article provides general information for upgrading instances in a standalone or high availability configuration only.
|
||||
|
||||
## Planning your upgrade strategy
|
||||
|
||||
### Plan your upgrade
|
||||
|
||||
* Review the release notes and documented known issues before performing an upgrade. See "[AUTOTITLE](/admin/release-notes)" and "[AUTOTITLE](/admin/upgrading-your-instance/troubleshooting-upgrades/known-issues-with-upgrades-to-your-instance)."
|
||||
* Review "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements)" to ensure you understand the requirements and recommendations for upgrading.
|
||||
* Check that {% data variables.location.product_location %}'s data disk is at least 15% free. {% data variables.product.company_short %} recommends ensuring there is additional free storage on the disk. In some rare cases, for customers with large data volumes, this threshold may differ. See "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/increasing-storage-capacity)."
|
||||
* Check that you have sufficient hardware resources for {% data variables.product.product_name %}. {% data reusables.enterprise_installation.preflight-checks %}
|
||||
* Ensure you have a copy of all custom firewall rules for {% data variables.location.product_location %}, as customized rules will not persist post-upgrade. You must reapply any custom rules following the upgrade. See "[AUTOTITLE](/admin/configuring-settings/configuring-network-settings/configuring-built-in-firewall-rules)."
|
||||
* For instances in a high availability configuration, check that the status of replication reports `OK` before upgrading. See "[AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-high-availability/monitoring-a-high-availability-configuration)."
|
||||
* Consider configuring the IP exception list for maintenance mode, so you can temporarily limit access to {% data variables.location.product_location %} to validate your server health after an upgrade. See "[AUTOTITLE](/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode)."
|
||||
|
||||
### Choose your upgrade version and package
|
||||
|
||||
* Determine an upgrade strategy and choose a version to upgrade to.
|
||||
* You can upgrade a {% data variables.product.product_name %} instance to a new patch release or to a new feature release.
|
||||
* Refer to the [{% data variables.enterprise.upgrade_assistant %}](https://support.github.com/enterprise/server-upgrade) to find the upgrade path from your current release version, to a new patch or feature release version.
|
||||
* Choose an upgrade package (hotpatch or upgrade package).
|
||||
* To upgrade to a patch release, you can use a hotpatch or an upgrade package. To upgrade to a feature release, you must use an upgrade package.
|
||||
* If you use an upgrade package, schedule a maintenance window for {% data variables.product.prodname_ghe_server %} end users. If you are using a hotpatch, maintenance mode is not required.
|
||||
* If you have enabled automatic update checks, site administrators will be notified that an upgrade package has been downloaded and is available. See "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/enabling-automatic-update-checks)".
|
||||
* Release candidate builds are intended solely for use in a test environment. Do not install a release candidate build in a production environment. Do not upgrade from the release candidate to later versions, including generally available releases.
|
||||
|
||||
### Consider if other application updates are required
|
||||
|
||||
Check if you need to upgrade the following applications:
|
||||
|
||||
* {% data variables.product.prodname_actions %} runners must be updated if {% data variables.location.product_location %} uses ephemeral self-hosted runners for {% data variables.product.prodname_actions %} and automatic updates are disabled. Upgrade runners to the minimum version of application required by your upgraded instance, before performing your upgrade. To find the minimum required version for your release, see "[AUTOTITLE](/admin/all-releases#minimum-github-actions-runner-application-versions)."
|
||||
* {% data variables.product.prodname_enterprise_backup_utilities %}. Your {% data variables.product.prodname_enterprise_backup_utilities %} version needs to be the same version as, or at most two versions ahead of {% data variables.location.product_location %}.
|
||||
* You may need to upgrade {% data variables.product.prodname_enterprise_backup_utilities %} to a newer version, prior to upgrading your instance.
|
||||
* You may also want to plan to upgrade {% data variables.product.prodname_enterprise_backup_utilities %} to a newer version after upgrading your instance.
|
||||
|
||||
See "[AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance)" and the [README](https://github.com/github/backup-utils#readme) in the {% data variables.product.prodname_enterprise_backup_utilities %} project documentation.
|
||||
|
||||
### Plan a maintenance window
|
||||
|
||||
* Depending on your upgrade strategy, significant downtime may be required.
|
||||
* The best way to determine the expected duration of downtime is to test your upgrade in a staging environment first. See "[AUTOTITLE](/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance)."
|
||||
* The maintenance window for your upgrade depends on the type of upgrade you perform.
|
||||
* Upgrades using a hotpatch usually don't require a maintenance window. Sometimes a reboot is required, which you can perform at a later time.
|
||||
|
||||
> [!NOTE]
|
||||
> Hotpatches require a configuration run, which can cause a brief period of errors or unresponsiveness for some or all services on {% data variables.location.product_location %}. You are not required to enable maintenance mode during installation of a hotpatch, but doing so will guarantee that users see a maintenance page instead of errors or timeouts. See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
* Patch releases using an upgrade package typically require less than five minutes of downtime.
|
||||
* Upgrading to a new feature release that include data migrations may cause a few hours of downtime, depending on storage performance and the amount of data that is migrated. During this time none of your users will be able to use the enterprise.
|
||||
|
||||
## Communicating your upgrade
|
||||
|
||||
* Prior to your upgrade, you can publish a global announcement banner to highlight important information to your users, such as incoming changes or possible downtime. See "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)."
|
||||
* At the time of the upgrade, you can enable maintenance mode and set a custom message to inform users that the instance is temporarily unavailable. See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
|
||||
## Preparing your backup strategy
|
||||
|
||||
### Create a backup snapshot
|
||||
|
||||
Ensure you have a recent, successful backup snapshot of your instance's primary node before you start the upgrade process. See "[AUTOTITLE](/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance)" and the [README](https://github.com/github/backup-utils#readme) in the {% data variables.product.prodname_enterprise_backup_utilities %} project documentation.
|
||||
|
||||
### Create a VM snapshot
|
||||
|
||||
If you're upgrading to a new feature release, a virtual machine (VM) snapshot is required. If you're ugprading to a patch release, you can attach the existing data disk.
|
||||
|
||||
Create a virtual machine (VM) snapshot of your instance's primary node immediately before upgrading, and only when maintenance mode has been enabled or the instance has been powered down. See "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot)".
|
||||
|
||||
## Installing an upgrade package
|
||||
|
||||
Review the considerations for upgrades, and complete any preparation steps as described above, before you start installing an upgrade package.
|
||||
|
||||
The instructions for upgrading your {% data variables.product.product_name %} instance differ depending on the type of upgrade you're performing and the number of nodes your instance has.
|
||||
|
||||
* [Upgrading with a hotpatch](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-a-hotpatch#upgrading-with-a-hotpatch)
|
||||
* [Upgrading a standalone instance using a hotpatch](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-a-hotpatch#upgrading-a-standalone-instance-using-a-hotpatch)
|
||||
* [Upgrading an instance with multiple nodes using a hotpatch](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-a-hotpatch#upgrading-an-instance-with-multiple-nodes-using-a-hotpatch)
|
||||
* [Upgrading with an upgrade package](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package#upgrading-with-an-upgrade-package)
|
||||
* [Upgrading a standalone instance using an upgrade package](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package#upgrading-a-standalone-instance-using-an-upgrade-package)
|
||||
* [Upgrading an instance with multiple nodes using an upgrade package](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package#upgrading-an-instance-with-multiple-nodes-using-an-upgrade-package)
|
||||
|
||||
## Completing post-upgrade tasks
|
||||
|
||||
* Check the status of background jobs, and review the upgrade log for errors.
|
||||
* Check basic {% data variables.product.product_name %} functionality. For example, ensure you can sign in via the user interface, and verify that several of your organizations, repositories and issues can be reached as expected. It's also a good idea to manually run several Git fetches, clones, and pushes using SSH and/or HTTPS, and check that API requests and webhook deliveries complete successfully.
|
||||
* Reapply any custom firewall rules. See "[AUTOTITLE](/admin/configuring-settings/configuring-network-settings/configuring-built-in-firewall-rules)."
|
||||
* Delete any VM snapshots taken prior to upgrading. See "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot)."
|
||||
* Disable maintenance mode, and update any pre-upgrade communications such as announcement banners. See "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner)" and "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
* Monitor all queued background jobs on your instance to ensure they complete successfully. See "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities)."
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: Taking a snapshot
|
||||
intro: 'To save your {% data variables.product.product_name %} data before upgrading, take a virtual machine snapshot.'
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#taking-a-snapshot
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
shortTitle: Take a snapshot
|
||||
---
|
||||
|
||||
## About snapshots
|
||||
|
||||
A snapshot stores the state of a virtual machine (VM) at a point in time. {% data variables.product.company_short %} highly recommends taking a hypervisor level snapshot before upgrading your VM so that if an upgrade fails, you can revert your VM back to the snapshot.
|
||||
|
||||
## Types of snapshots
|
||||
|
||||
There are two types of snapshots:
|
||||
|
||||
* **VM snapshots** save your entire VM state, including user data and configuration data. This snapshot method requires a large amount of disk space and is time consuming.
|
||||
* **Data disk snapshots** only save your user data.
|
||||
|
||||
## Creating a snapshot
|
||||
|
||||
{% data variables.product.company_short %} only recommends taking a VM snapshot when the instance's VM is powered down, or when the instance is in maintenance mode and all background jobs have finished.
|
||||
|
||||
The type of snapshot you can take depends on the platform you use.
|
||||
|
||||
* Some platforms don't allow you to take a snapshot of just your data disk. For these platforms, you'll need to take a snapshot of the entire VM.
|
||||
* If your hypervisor does not support full VM snapshots, you should take a snapshot of the root disk and data disk in quick succession.
|
||||
|
||||
| Platform | Snapshot method | Documentation |
|
||||
|---|---|---|
|
||||
| Amazon AWS | Disk | [Create Amazon EBS snapshots](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-creating-snapshot.html) in the AWS documentation
|
||||
| Azure | VM | [Create a snapshot of a virtual hard disk on an Azure VM](https://learn.microsoft.com/azure/virtual-machines/snapshot-copy-managed-disk) in Microsoft Learn
|
||||
| Hyper-V | VM | [Enable or disable checkpoints in Hyper-V](https://docs.microsoft.com/windows-server/virtualization/hyper-v/manage/enable-or-disable-checkpoints-in-hyper-v) in Microsoft Learn
|
||||
| Google Compute Engine | Disk | [Create and manage disk snapshots](https://cloud.google.com/compute/docs/disks/create-snapshots) in the Google Cloud documentation
|
||||
| VMware | VM | [Taking Snapshots of a Virtual Machine](https://docs.vmware.com/en/VMware-vSphere/7.0/com.vmware.vsphere.hostclient.doc/GUID-64B866EF-7636-401C-A8FF-2B4584D9CA72.html) in VMware Docs
|
||||
@@ -8,6 +8,8 @@ redirect_from:
|
||||
- /admin/enterprise-management/upgrade-requirements
|
||||
- /enterprise/admin/guides/installation/about-upgrade-requirements
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrade-requirements
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrade-requirements
|
||||
- /admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/upgrade-requirements
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: reference
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Troubleshooting upgrades
|
||||
intro: 'Review common issues and solutions for issues that may impact the upgrade process, or may occur after an upgrade.'
|
||||
versions:
|
||||
ghes: '*'
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
children:
|
||||
- /restoring-from-a-failed-upgrade
|
||||
- /known-issues-with-upgrades-to-your-instance
|
||||
shortTitle: Troubleshoot an upgrade
|
||||
---
|
||||
@@ -11,6 +11,8 @@ topics:
|
||||
shortTitle: Known issues with upgrades
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance
|
||||
- /admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance
|
||||
- /admin/monitoring-and-managing-your-instance/updating-the-virtual-machine-and-physical-resources/known-issues-with-upgrades-to-your-instance
|
||||
---
|
||||
|
||||
## About known issues with {% data variables.product.prodname_ghe_server %} upgrades
|
||||
@@ -0,0 +1,28 @@
|
||||
---
|
||||
title: Restoring from a failed upgrade
|
||||
intro: 'Learn how to roll back from a failed upgrade.'
|
||||
redirect_from:
|
||||
- /admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#restoring-from-a-failed-upgrade
|
||||
versions:
|
||||
ghes: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Enterprise
|
||||
- Upgrades
|
||||
- Troubleshooting
|
||||
shortTitle: Restore from a failed upgrade
|
||||
---
|
||||
|
||||
If an upgrade fails or is interrupted, you should revert your instance back to its previous state. The process for completing this depends on the type of upgrade.
|
||||
|
||||
If your instance is configured for high availability and your primary node upgrade fails, you can promote the (not upgraded) replica to be the primary. You will also need to update your DNS to point to the new primary node. Once you have a working primary node, you can then consider creating a new replica node. See "[AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-high-availability/about-high-availability-configuration#network-traffic-failover-strategies)" and "[AUTOTITLE](/admin/monitoring-and-managing-your-instance/configuring-high-availability/recovering-a-high-availability-configuration)."
|
||||
|
||||
## Rolling back a patch release
|
||||
|
||||
To roll back a patch release, use the `ghe-upgrade` command with the `--allow-patch-rollback` switch. Before rolling back, replication must be temporarily stopped by running `ghe-repl-stop` on all replica nodes{% ifversion ghes > 3.13 %}, or `ghe-repl-stop-all` on the primary node{% endif %}. {% data reusables.enterprise_installation.command-line-utilities-ghe-upgrade-rollback %}
|
||||
|
||||
After the rollback is complete, restart replication by running `ghe-repl-start` on all nodes{% ifversion ghes > 3.13 %}, or `ghe-repl-start-all` on the primary node{% endif %}. See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-upgrade)."
|
||||
|
||||
## Rolling back a feature release
|
||||
|
||||
To roll back from a feature release, restore from a virtual machine snapshot to ensure that root and data partitions are in a consistent state. See "[AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot)."
|
||||
@@ -22,17 +22,18 @@ upgrade_your_instance:
|
||||
ghes: '*'
|
||||
guides:
|
||||
- >-
|
||||
/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks
|
||||
/admin/upgrading-your-instance/preparing-to-upgrade/overview-of-the-upgrade-process
|
||||
- /admin/upgrading-your-instance/preparing-to-upgrade/upgrade-requirements
|
||||
- >-
|
||||
/admin/upgrading-your-instance/preparing-to-upgrade/enabling-automatic-update-checks
|
||||
- >-
|
||||
/admin/installing-your-enterprise-server/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance
|
||||
- >-
|
||||
/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrade-requirements
|
||||
- >-
|
||||
/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise
|
||||
- >-
|
||||
/admin/administering-your-instance/configuring-maintenance-mode/enabling-and-scheduling-maintenance-mode
|
||||
- >-
|
||||
/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server
|
||||
- /admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot
|
||||
- /admin/upgrading-your-instance/performing-an-upgrade
|
||||
adopting_github_actions_for_your_enterprise_ghec:
|
||||
title: Adopt GitHub Actions for your enterprise
|
||||
description: >-
|
||||
@@ -91,9 +92,9 @@ increase_fault_tolerance:
|
||||
- >-
|
||||
/admin/backing-up-and-restoring-your-instance/configuring-backups-on-your-instance
|
||||
- >-
|
||||
/admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/about-high-availability-configuration
|
||||
/admin/monitoring-and-managing-your-instance/configuring-high-availability/about-high-availability-configuration
|
||||
- >-
|
||||
/admin/monitoring-managing-and-updating-your-instance/configuring-high-availability/creating-a-high-availability-replica
|
||||
/admin/monitoring-and-managing-your-instance/configuring-high-availability/creating-a-high-availability-replica
|
||||
- >-
|
||||
/admin/configuring-settings/configuring-network-settings/using-github-enterprise-server-with-a-load-balancer
|
||||
improve_security_of_your_instance:
|
||||
|
||||
@@ -15,7 +15,7 @@ sections:
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/3542
|
||||
- |
|
||||
To ensure an instance's readiness for an upgrade to a new feature release of GitHub Enterprise Server, administrators can ensure that background tasks from a previous upgrade are complete using the `ghe-check-background-upgrade-jobs` command-line utility. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-a-standalone-instance-using-an-upgrade-package)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-check-background-upgrade-jobs)."
|
||||
To ensure an instance's readiness for an upgrade to a new feature release of GitHub Enterprise Server, administrators can ensure that background tasks from a previous upgrade are complete using the `ghe-check-background-upgrade-jobs` command-line utility. For more information, see "[AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package#upgrading-a-standalone-instance-using-an-upgrade-package)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-check-background-upgrade-jobs)."
|
||||
# https://github.com/github/releases/issues/3531
|
||||
- |
|
||||
When backing up an instance in a cluster configuration using GitHub Enterprise Server Backup Utilities, the pre-flight routine includes a health check for all nodes and notifies administrators of any issues before the backup begins.
|
||||
@@ -185,4 +185,3 @@ sections:
|
||||
notes:
|
||||
- |
|
||||
GitHub will deprecate team discussions for users in GitHub Enterprise Server 3.13. In GitHub Enterprise Server 3.12, a banner appears atop teams' discussions with information about the deprecation, including a link to tooling to migrate existing team discussions to GitHub Discussions. For more information, see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)" and "[AUTOTITLE](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." [Updated: 2024-03-04]
|
||||
|
||||
|
||||
@@ -10,7 +10,7 @@ sections:
|
||||
notes:
|
||||
# https://github.com/github/releases/issues/3542
|
||||
- |
|
||||
To ensure an instance's readiness for an upgrade to a new feature release of GitHub Enterprise Server, administrators can ensure that background tasks from a previous upgrade are complete using the `ghe-check-background-upgrade-jobs` command-line utility. For more information, see "[AUTOTITLE](/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-a-standalone-instance-using-an-upgrade-package)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-check-background-upgrade-jobs)."
|
||||
To ensure an instance's readiness for an upgrade to a new feature release of GitHub Enterprise Server, administrators can ensure that background tasks from a previous upgrade are complete using the `ghe-check-background-upgrade-jobs` command-line utility. For more information, see "[AUTOTITLE](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package#upgrading-a-standalone-instance-using-an-upgrade-package)" and "[AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-check-background-upgrade-jobs)."
|
||||
# https://github.com/github/releases/issues/3531
|
||||
- |
|
||||
When backing up an instance in a cluster configuration using GitHub Enterprise Server Backup Utilities, the pre-flight routine includes a health check for all nodes and notifies administrators of any issues before the backup begins.
|
||||
@@ -25,7 +25,7 @@ sections:
|
||||
# https://github.com/github/releases/issues/3802
|
||||
- |
|
||||
On an instance in a cluster configuration, administrators can more easily configure or tear down a high availability replica of the cluster. For more information, see the documentation for the following utilities in the "Command-line utilities" article:
|
||||
|
||||
|
||||
- [`ghe-cluster-repl-bootstrap`](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-cluster-repl-bootstrap)
|
||||
- [`ghe-cluster-repl-teardown`](/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities#ghe-cluster-repl-teardown)
|
||||
|
||||
|
||||
@@ -1,5 +1 @@
|
||||
{% note %}
|
||||
|
||||
**Note:** If you've enabled automatic update checks, you don't need to download the upgrade package and can use the file that was automatically downloaded. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks)."
|
||||
|
||||
{% endnote %}
|
||||
> [!NOTE] If you've enabled automatic update checks, you don't need to download the upgrade package and can use the file that was automatically downloaded. For more information, see "[AUTOTITLE](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/enabling-automatic-update-checks)."
|
||||
|
||||
@@ -4,4 +4,4 @@ You can use hotpatching to upgrade to a newer patch release, but not a feature r
|
||||
|
||||
Hotpatches do not generally require a reboot. If a hotpatch does require a reboot, the {% data variables.product.product_name %} release notes will indicate the requirement.
|
||||
|
||||
Hotpatches require a configuration run, which can cause a brief period of errors or unresponsiveness for some or all services on {% data variables.location.product_location %}. You are not required to enable maintenance mode during installation of a hotpatch, but doing so will guarantee that users see a maintenance page instead of errors or timeouts. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
Hotpatches require a configuration run, which can cause a brief period of errors or unresponsiveness for some or all services on {% data variables.location.product_location %}. You are not required to enable maintenance mode during installation of a hotpatch, but doing so will guarantee that users see a maintenance page instead of errors or timeouts. See "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)."
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
[Hotpatch upgrades](/admin/monitoring-managing-and-updating-your-instance/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server#upgrading-with-a-hotpatch) from GitHub Enterprise Server version `3.11.0` to `3.11.1` will result in the appliance losing network connectivity after a reboot.
|
||||
[Hotpatch upgrades](/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-a-hotpatch) from GitHub Enterprise Server version `3.11.0` to `3.11.1` will result in the appliance losing network connectivity after a reboot.
|
||||
If you have upgraded to GitHub Enterprise Server `3.11.1` from `3.11.0` using a hotpatch upgrade, please contact [GitHub Support](https://support.github.com/) for assistance.
|
||||
If you have upgraded directly to GitHub Enterprise Server `3.11.1` from previous versions (for example, from any version of GitHub Enterprise Server in the 3.9 or 3.10 series), your instance is not affected by this issue.
|
||||
|
||||
Reference in New Issue
Block a user