From 1b14395e4a77ba50cb1b0074d494a967d9de111e Mon Sep 17 00:00:00 2001 From: mc <42146119+mchammer01@users.noreply.github.com> Date: Fri, 17 Jan 2025 13:17:53 +0000 Subject: [PATCH] Hack week 2025: remove unneeded FBV instances (13) - Enterprise & OIDC (#53982) --- .../command-line-utilities.md | 51 ------------------- ...-management-policies-in-your-enterprise.md | 2 - ...izing-user-messages-for-your-enterprise.md | 2 +- ...g-github-actions-with-amazon-s3-storage.md | 14 +---- ...-github-actions-with-azure-blob-storage.md | 12 +---- ...ithub-actions-with-google-cloud-storage.md | 14 +---- ...bling-github-actions-with-minio-storage.md | 6 --- ...ng-a-cluster-node-running-data-services.md | 29 ----------- ...oring-a-high-availability-configuration.md | 12 +---- .../upgrading-with-an-upgrade-package.md | 5 +- .../upgrade-requirements.md | 2 +- .../actions/enterprise-oidc-prereqs.md | 2 - .../git-events-not-in-search-results.md | 4 -- 13 files changed, 8 insertions(+), 147 deletions(-) diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md index f4950e63333f..fc18f6fb0e8d 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md @@ -33,7 +33,6 @@ $ ghe-announce -u > Removed the announcement message ``` -{% ifversion ghe-announce-dismiss %} To allow each user to dismiss the announcement for themselves, use the `-d` flag. ```shell @@ -46,8 +45,6 @@ $ ghe-announce -u > dismissible: MESSAGE ``` -{% endif %} - You can also set an announcement banner using the enterprise settings on {% data variables.product.product_name %}. For more information, see [AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise#creating-a-global-announcement-banner). @@ -791,8 +788,6 @@ Flag | Description {% endif %} -{% ifversion ghe-spokes-deprecation-phase-1 %} - ### ghe-spokesctl This utility allows you to manage replication of repositories on the distributed Git servers. @@ -813,36 +808,6 @@ To evacuate storage services on a cluster node: ghe-spokesctl server set evacuating git-server-UUID ``` -{% else %} - -### ghe-spokes - -This utility allows you to manage the three copies of each repository on the distributed Git servers. - -```shell -ghe-spokes -``` - -To show a summary of repository location and health: - -```shell -ghe-spokes status -``` - -To show the servers in which the repository is stored: - -```shell -ghe-spokes route -``` - -To evacuate storage services on a cluster node: - -```shell -ghe-spokes server evacuate git-server-UUID -``` - -{% endif %} - ### ghe-storage This utility allows you to evacuate all storage services before evacuating a cluster node. @@ -984,13 +949,9 @@ This utility tests the blob storage configuration for {% data variables.product. For more information about the configuration of {% data variables.product.prodname_actions %}, see [AUTOTITLE](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server). -{% ifversion ghes-actions-storage-oidc %} - > [!NOTE] > This utility only works with configurations that use a credentials-based connection to the storage provider. To test OpenID Connect (OIDC) configurations, use [`ghe-actions-test-storage-with-oidc`](#ghe-actions-test-storage-with-oidc). -{% endif %} - ```shell ghe-actions-precheck -p [PROVIDER] -cs ["CONNECTION-STRING"] ``` @@ -1001,8 +962,6 @@ If your storage system is configured correctly, you'll see the following output. All Storage tests passed ``` -{% ifversion ghes-actions-storage-oidc %} - ### ghe-actions-test-storage-with-oidc This utility checks that the blob storage provider for {% data variables.product.prodname_actions %} on {% data variables.location.product_location %} is valid when OpenID Connect (OIDC) is used. @@ -1014,8 +973,6 @@ This utility checks that the blob storage provider for {% data variables.product ghe-actions-test-storage-with-oidc -p [PROVIDER] -cs ["CONNECTION-STRING"] ``` -{% endif %} - ### ghe-actions-stop This utility stops {% data variables.product.prodname_actions %} from running on {% data variables.location.product_location %}. @@ -1330,8 +1287,6 @@ In this example, `ghe-repl-status -vv` sends verbose status information from a r ## Upgrading {% data variables.product.prodname_ghe_server %} -{% ifversion ghes-upgrade-complete-indicator %} - ### ghe-check-background-upgrade-jobs During an upgrade to a feature release, this utility displays the status of background jobs on {% data variables.location.product_location %}. If you're running back-to-back upgrades, you should use this utility to check that all background jobs are complete before proceeding with the next upgrade. @@ -1347,10 +1302,6 @@ During an upgrade to a feature release, this utility displays the status of back ghe-check-background-upgrade-jobs ``` -{% endif %} - -{% ifversion ghe-migrations-cli-utility %} - ### ghe-migrations During an upgrade to a feature release, this utility displays the status of active database migrations on {% data variables.location.product_location %}. The output includes a version identifier for the migration, the migration's name, the migration's status, and the current duration of the migration. @@ -1373,8 +1324,6 @@ By default, the visualizer refreshes every second. To specify the duration in se ghe-migrations -refresh_rate SECONDS ``` -{% endif %} - ### ghe-update-check This utility will check to see if a new patch release of {% data variables.product.prodname_enterprise %} is available. If it is, and if space is available on your instance, it will download the package. By default, it's saved to _/var/lib/ghe-updates_. An administrator can then [perform the upgrade](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources). diff --git a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md index 9b7da58c9050..3526d3019c4d 100644 --- a/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md +++ b/content/admin/enforcing-policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise.md @@ -119,9 +119,7 @@ People with admin permissions can set a more granular forking policy. For more i {% data reusables.enterprise-accounts.repositories-tab %} 1. Under "Repository forking", review the information about changing the setting. {% data reusables.enterprise-accounts.view-current-policy-config-orgs %} 1. Under "Repository forking", select the dropdown menu and click a policy. -{%- ifversion innersource-fork-policies %} 1. If forking is enabled, select a policy for where users are allowed to fork repositories. -{%- endif %} ## Enforcing a policy for inviting{% ifversion ghec %} outside{% endif %} collaborators to repositories diff --git a/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md b/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md index 8b83db5667b0..2c0d0601c501 100644 --- a/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/communicating-information-to-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md @@ -107,7 +107,7 @@ You can also set an announcement banner{% ifversion ghes %} in the administrativ {% data reusables.enterprise-accounts.access-enterprise %} {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %} -{%- ifversion ghe-announce-dismiss %} +{%- ifversion ghes %} 1. Optionally, to allow each user to dismiss the announcement, select **User dismissible**. {%- endif %} 1. Optionally, to allow each user to dismiss the announcement, select **Allow users to dismiss the announcement**. diff --git a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md index 88b3c1cc0dbc..db8e9acd8c02 100644 --- a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md +++ b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-amazon-s3-storage.md @@ -18,9 +18,7 @@ shortTitle: Amazon S3 storage {% data reusables.actions.enterprise-storage-about %} -{% ifversion ghes-actions-storage-oidc %} {% data reusables.actions.enterprise-storage-about-oidc %} -{% endif %} ## Prerequisites @@ -35,8 +33,6 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav {% data reusables.actions.enterprise-common-prereqs %} {% data reusables.actions.enterprise-oidc-prereqs %} -{% ifversion ghes-actions-storage-oidc %} - ## Enabling {% data variables.product.prodname_actions %} with Amazon S3 using OIDC (recommended) To configure {% data variables.product.prodname_ghe_server %} to use OIDC with an Amazon S3 bucket, you must first create an Amazon OIDC provider, then create an Identity and Access Management (IAM) role, and finally configure {% data variables.product.prodname_ghe_server %} to use the provider and role to access your S3 bucket. @@ -150,9 +146,7 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} -{% endif %} - -## Enabling {% data variables.product.prodname_actions %} with Amazon S3 storage{% ifversion ghes-actions-storage-oidc %} using access keys{% endif %} +## Enabling {% data variables.product.prodname_actions %} with Amazon S3 storage using access keys 1. Using the AWS Console or CLI, create an access key for your storage bucket. {% data reusables.actions.enterprise-s3-permission %} @@ -162,16 +156,10 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -{%- ifversion ghes-actions-storage-oidc %} {% data reusables.actions.enterprise-s3-storage-setup %} 1. Under "Authentication", select **Credentials-based**, and enter your storage bucket's details: {% data reusables.actions.enterprise-s3-storage-credential-fields %} -{%- else %} -1. Under "Artifact & Log Storage", select **Amazon S3**, then enter your storage bucket's details: - - {% data reusables.actions.enterprise-s3-storage-credential-fields %} -{%- endif %} {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md index 85a576560365..3c131c32e1ee 100644 --- a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md +++ b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-azure-blob-storage.md @@ -18,9 +18,7 @@ shortTitle: Azure Blob storage {% data reusables.actions.enterprise-storage-about %} -{% ifversion ghes-actions-storage-oidc %} {% data reusables.actions.enterprise-storage-about-oidc %} -{% endif %} ## Prerequisites @@ -38,8 +36,6 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav {% data reusables.actions.enterprise-common-prereqs %} {% data reusables.actions.enterprise-oidc-prereqs %} -{% ifversion ghes-actions-storage-oidc %} - ## Enabling {% data variables.product.prodname_actions %} with Azure Blob storage using OIDC (recommended) To configure {% data variables.product.prodname_ghe_server %} to use OIDC with an Azure storage account, you must first register a Microsoft Entra ID (previously known as Azure AD) application with OIDC credentials, then configure your storage account, and finally configure {% data variables.product.prodname_ghe_server %} to access the storage container using the Entra ID. @@ -94,20 +90,14 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with a {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} -{% endif %} - -## Enabling {% data variables.product.prodname_actions %} with Azure Blob storage{% ifversion ghes-actions-storage-oidc %} using a connection string{% endif %} +## Enabling {% data variables.product.prodname_actions %} with Azure Blob storage using a connection string {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -{%- ifversion ghes-actions-storage-oidc %} {% data reusables.actions.enterprise-azure-storage-setup %} 1. Under "Authentication", select **Credentials-based**, and enter your Azure storage account's connection string. For more information on getting the connection string for your storage account, see the [Azure documentation](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys). -{%- else %} -1. Under "Artifact & Log Storage", select **Azure Blob Storage**, then enter your Azure storage account's connection string. For more information about getting the connection string for your storage account, see the [View account access keys](https://docs.microsoft.com/en-us/azure/storage/common/storage-account-keys-manage?tabs=azure-portal#view-account-access-keys) on Microsoft Learn. -{%- endif %} {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md index f5f216e5f733..84ed21a90a5b 100644 --- a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md +++ b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-google-cloud-storage.md @@ -20,9 +20,7 @@ redirect_from: {% data reusables.actions.enterprise-storage-about %} -{% ifversion ghes-actions-storage-oidc %} {% data reusables.actions.enterprise-storage-about-oidc %} -{% endif %} ## Prerequisites @@ -32,8 +30,6 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav {% data reusables.actions.enterprise-common-prereqs %} {% data reusables.actions.enterprise-oidc-prereqs %} -{% ifversion ghes-actions-storage-oidc %} - ## Enabling {% data variables.product.prodname_actions %} with Google Cloud Storage using OIDC (recommended) To configure {% data variables.product.prodname_ghe_server %} to use OIDC with Google Cloud Storage, you must first create a Google Cloud service account, then create a Google Cloud identity pool and identity provider, and finally configure {% data variables.product.prodname_ghe_server %} to use the provider and service account to access your Google Cloud Storage bucket. @@ -119,9 +115,7 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} -{% endif %} - -## Enabling {% data variables.product.prodname_actions %} with Google Cloud Storage{% ifversion ghes-actions-storage-oidc %} using a HMAC key{% endif %} +## Enabling {% data variables.product.prodname_actions %} with Google Cloud Storage using a HMAC key 1. Create a Google Cloud service account that can access the bucket, and create a Hash-based Message Authentication Code (HMAC) key for the service account. For more information, see [Manage HMAC keys for service accounts](https://cloud.google.com/storage/docs/authentication/managing-hmackeys) in the Google Cloud documentation. @@ -140,16 +134,10 @@ To configure {% data variables.product.prodname_ghe_server %} to use OIDC with G {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -{%- ifversion ghes-actions-storage-oidc %} {% data reusables.actions.enterprise-gcp-storage-setup %} 1. Under "Authentication", select **Credentials-based**, and enter your storage bucket's details: {% data reusables.actions.enterprise-gcp-storage-credential-fields %} -{%- else %} -1. Under "Artifact & Log Storage", select **Google Cloud Storage**, and enter your bucket's details: - - {% data reusables.actions.enterprise-gcp-storage-credential-fields %} -{%- endif %} {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage.md b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage.md index 427e9c94413f..cc421f642e16 100644 --- a/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage.md +++ b/content/admin/managing-github-actions-for-your-enterprise/enabling-github-actions-for-github-enterprise-server/enabling-github-actions-with-minio-storage.md @@ -37,7 +37,6 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav {% data reusables.enterprise_site_admin_settings.management-console %} {% data reusables.enterprise_management_console.actions %} {% data reusables.actions.enterprise-enable-checkbox %} -{%- ifversion ghes-actions-storage-oidc %} {% data reusables.actions.enterprise-s3-storage-setup %} 1. Under "Authentication", select **Credentials-based**, and enter your storage bucket's details: @@ -45,11 +44,6 @@ Before enabling {% data variables.product.prodname_actions %}, make sure you hav > For MinIO, you cannot use OpenID Connect (OIDC) authentication. You must use credentials-based authentication. {% data reusables.actions.enterprise-minio-storage-credential-fields %} -{%- else %} -1. Under "Artifact & Log Storage", select **Amazon S3**, and enter your storage bucket's details: - - {% data reusables.actions.enterprise-minio-storage-credential-fields %} -{% endif %} 1. Under "Artifact & Log Storage", select **Force path style**. {% data reusables.enterprise_management_console.test-storage-button %} {% data reusables.enterprise_management_console.save-settings %} diff --git a/content/admin/monitoring-and-managing-your-instance/configuring-clustering/evacuating-a-cluster-node-running-data-services.md b/content/admin/monitoring-and-managing-your-instance/configuring-clustering/evacuating-a-cluster-node-running-data-services.md index 49fadea8b352..d34f86f38ce6 100644 --- a/content/admin/monitoring-and-managing-your-instance/configuring-clustering/evacuating-a-cluster-node-running-data-services.md +++ b/content/admin/monitoring-and-managing-your-instance/configuring-clustering/evacuating-a-cluster-node-running-data-services.md @@ -49,7 +49,6 @@ If you plan to take a node offline and the node runs any of the following roles, * `git-server`: - {% ifversion ghe-spokes-deprecation-phase-1 %} * Command: ```shell @@ -57,15 +56,7 @@ If you plan to take a node offline and the node runs any of the following roles, ``` * Relevant output: `NETWORKS`, `GISTS` - {% else %} - * Command: - - ```shell - ghe-spokes evac-status git-server-UUID - ``` - * Relevant output: `Networks`, `Gists` - {% endif %} * `pages-server`: * Command: @@ -90,20 +81,10 @@ If you plan to take a node offline and the node runs any of the following roles, * Command (replace REASON FOR EVACUATION with the reason for evacuation): - {%- ifversion ghe-spokes-deprecation-phase-1 %} - ```shell ghe-spokesctl server set evacuating git-server-UUID 'REASON FOR EVACUATION' ``` - {%- else %} - - ```shell - ghe-spokes server evacuate git-server-UUID 'REASON FOR EVACUATION' - ``` - - {%- endif %} - * `pages-server`: * Command: @@ -133,20 +114,10 @@ If you plan to take a node offline and the node runs any of the following roles, * `git-server`: - {%- ifversion ghe-spokes-deprecation-phase-1 %} - ```shell ghe-spokesctl server evac-status git-server-UUID ``` - {%- else %} - - ```shell - ghe-spokes evac-status git-server-UUID - ``` - - {%- endif %} - * `pages-server`: ```shell diff --git a/content/admin/monitoring-and-managing-your-instance/configuring-high-availability/monitoring-a-high-availability-configuration.md b/content/admin/monitoring-and-managing-your-instance/configuring-high-availability/monitoring-a-high-availability-configuration.md index 0ecb3abb4fa9..d876fee255c0 100644 --- a/content/admin/monitoring-and-managing-your-instance/configuring-high-availability/monitoring-a-high-availability-configuration.md +++ b/content/admin/monitoring-and-managing-your-instance/configuring-high-availability/monitoring-a-high-availability-configuration.md @@ -37,7 +37,7 @@ You can also monitor replication status from the overview dashboard on your inst ## Monitoring replication using the {% data variables.product.prodname_cli %} You can monitor replication status on your instance using the `gh es` extension for {% data variables.product.prodname_cli %}. For more information, see the [GH ES CLI usage documentation](https://github.com/github/gh-es/blob/main/USAGE.md#gh-es-replication-status) and [AUTOTITLE](/admin/administering-your-instance/administering-your-instance-from-the-command-line/administering-your-instance-using-the-github-cli). - + {% endif %} {% ifversion replication-management-api %} @@ -91,26 +91,18 @@ If you've recently configured high availability or geo-replication, the initial #### Under-replicated repositories or repository networks -You can view a specific repository's replication status by connecting to a node and running the following {% ifversion ghe-spokes-deprecation-phase-1 %}commands{% else %}command{% endif %}, replacing OWNER with the repository's owner and REPOSITORY with the repository's name. +You can view a specific repository's replication status by connecting to a node and running the following commands, replacing OWNER with the repository's owner and REPOSITORY with the repository's name. ```text -{%- ifversion ghe-spokes-deprecation-phase-1 %} ghe-spokesctl check OWNER/REPOSITORY ghe-spokesctl info OWNER/REPOSITORY -{%- else %} -ghe-spokes diagnose OWNER/REPOSITORY -{%- endif %} ``` Alternatively, if you want to view a repository network's replication status, replace NETWORK-ID/REPOSITORY-ID with the network ID and repository ID number. ```text -{%- ifversion ghe-spokes-deprecation-phase-1 %} ghe-spokesctl check NETWORK-ID/REPOSITORY-ID ghe-spokesctl info NETWORK-ID/REPOSITORY-ID -{%- else %} -ghe-spokes diagnose NETWORK-ID/REPOSITORY-ID -{%- endif %} ``` #### Under-replicated storage objects diff --git a/content/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package.md b/content/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package.md index db282ec02d83..273bb286c5c3 100644 --- a/content/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package.md +++ b/content/admin/upgrading-your-instance/performing-an-upgrade/upgrading-with-an-upgrade-package.md @@ -47,15 +47,12 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea 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). + {%- 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 %} 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: diff --git a/content/admin/upgrading-your-instance/preparing-to-upgrade/upgrade-requirements.md b/content/admin/upgrading-your-instance/preparing-to-upgrade/upgrade-requirements.md index 755243aa9d46..1b2037fbdc22 100644 --- a/content/admin/upgrading-your-instance/preparing-to-upgrade/upgrade-requirements.md +++ b/content/admin/upgrading-your-instance/preparing-to-upgrade/upgrade-requirements.md @@ -29,7 +29,7 @@ topics: * If you’re several versions behind, upgrade {% data variables.location.product_location %} as far forward as possible with each step of your upgrade process. Using the latest version possible on each upgrade allows you to take advantage of performance improvements and bug fixes. For example, you could upgrade from {% data variables.product.prodname_enterprise %} 2.7 to 2.8 to 2.10, but upgrading from {% data variables.product.prodname_enterprise %} 2.7 to 2.9 to 2.10 uses a later version in the second step. * Use the latest patch release when upgrading. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} * Use a staging instance to test the upgrade steps. For more information, see [AUTOTITLE](/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance). -* When running multiple upgrades, {% ifversion ghes-upgrade-complete-indicator %}ensure data migrations and upgrade tasks running in the background are fully complete before proceeding to the next feature upgrade. To check the status of these processes, you can use the `ghe-migrations` and `ghe-check-background-upgrade-jobs` command-line utilities. {% ifversion ghes < 3.12 %} To use `ghe-check-background-upgrade-jobs` 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 %}For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#upgrading-github-enterprise-server).{% else %}wait at least 24 hours between feature upgrades to allow data migrations and upgrade tasks running in the background to fully complete.{% endif %} +* When running multiple upgrades, ensure data migrations and upgrade tasks running in the background are fully complete before proceeding to the next feature upgrade. To check the status of these processes, you can use the `ghe-migrations` and `ghe-check-background-upgrade-jobs` command-line utilities. {% ifversion ghes < 3.12 %} To use `ghe-check-background-upgrade-jobs` 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 %}For more information, see [AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#upgrading-github-enterprise-server). * Take a snapshot before upgrading your virtual machine. For more information, see [AUTOTITLE](/admin/upgrading-your-instance/preparing-to-upgrade/taking-a-snapshot). * Ensure you have a recent, successful backup of your instance. For more information, see the [{% data variables.product.prodname_enterprise_backup_utilities %} README.md file](https://github.com/github/backup-utils#readme). diff --git a/data/reusables/actions/enterprise-oidc-prereqs.md b/data/reusables/actions/enterprise-oidc-prereqs.md index e959373c645d..1da8e7861dc0 100644 --- a/data/reusables/actions/enterprise-oidc-prereqs.md +++ b/data/reusables/actions/enterprise-oidc-prereqs.md @@ -1,4 +1,3 @@ -{% ifversion ghes-actions-storage-oidc %} * If you are using OIDC for the connection to your storage provider, you must expose the following OIDC token service URLs on {% data variables.location.product_location_enterprise %} to the public internet: ```text @@ -7,4 +6,3 @@ ``` This ensures that the storage provider can contact {% data variables.location.product_location_enterprise %} for authentication. -{%- endif %} diff --git a/data/reusables/audit_log/git-events-not-in-search-results.md b/data/reusables/audit_log/git-events-not-in-search-results.md index e506da1111bb..c4c31887da53 100644 --- a/data/reusables/audit_log/git-events-not-in-search-results.md +++ b/data/reusables/audit_log/git-events-not-in-search-results.md @@ -1,6 +1,2 @@ -{% ifversion git-events-audit-log %} - > [!NOTE] > Git events are not included in search results. - -{% endif %}