Configuration des limites de débit

À propos des limitations de débit pour GitHub Enterprise Server

Les limites de débit permettent d’éviter une utilisation excessive des ressources sur votre instance GitHub Enterprise Server susceptibles d’affecter la disponibilité ou les performances de tous les utilisateurs. Vous pouvez configurer des limitations de débit pour GitHub Enterprise Server APIs et GitHub Actions.

Implémentez des limites de débit soigneusement et communiquez avec vos utilisateurs au fur et à mesure que vous les paramétrez. Commencez par des limites de taux permissives et ajustez-les progressivement en fonction de votre environnement.

Vous pouvez aussi configurer des limites de débit pour des tentatives d’authentification auprès de la Console de gestion. Pour plus d’informations, consultez « Gestion de l’accès à la console de gestion ».

Activation des limites de débit pour les GitHub Enterprise Server APIs

Trop de requêtes adressées à GitHub Enterprise Server APIs peuvent ralentir votre instance ou la rendre indisponible. Pour plus d’informations sur la façon dont les limites de débit d’API affectent vos utilisateurs, consultez Limites de débit pour l'API REST.

Vous pouvez exempter des utilisateurs spécifiques des limites de débit d’API à l’aide de l’utilitaire ghe-config dans l’interpréteur de commandes d’administration. Pour plus d’informations, consultez « Utilitaires de ligne de commande ».

1. À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.

2. Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.

3. Dans la barre latérale « Site admin », cliquez sur Console de gestion.

4. 1. À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.

5. Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.

6. Dans la barre latérale « Site admin », cliquez sur Console de gestion.

7. Sous « Limitation de débit », sélectionnez Activer la limitation de débit pour l’API HTTP.

8. Sous la barre latérale « Paramètres », cliquez sur Enregistrer les paramètres.

   Remarque

   L’enregistrement des paramètres dans la Console de gestion redémarre les services système, ce qui peut entraîner un temps d’arrêt visible pour l’utilisateur.

9. Attendez la fin de l’exécution de la configuration.

Entrez des limites pour les demandes authentifiées et non authentifiées pour chaque API, ou acceptez les limites par défaut préremplies.

1. Sous la barre latérale « Paramètres », cliquez sur Enregistrer les paramètres.

   Remarque

   L’enregistrement des paramètres dans la Console de gestion redémarre les services système, ce qui peut entraîner un temps d’arrêt visible pour l’utilisateur.

2. Attendez la fin de l’exécution de la configuration.

3. À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.

4. Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.

5. Dans la barre latérale « Site admin », cliquez sur Console de gestion.

6. Activation des limites de débit secondaires

7. Les limites de débit secondaire permettent de conserver votre instance GitHub Enterprise Server stable pour tous les utilisateurs.

8. Sous la barre latérale « Paramètres », cliquez sur Enregistrer les paramètres.

   Remarque

   L’enregistrement des paramètres dans la Console de gestion redémarre les services système, ce qui peut entraîner un temps d’arrêt visible pour l’utilisateur.

9. Attendez la fin de l’exécution de la configuration.

1. À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.

1. Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.
2. Dans la barre latérale « Site admin », cliquez sur Console de gestion.

Sous « Limitation de débit », sélectionnez Activer la limitation de débit secondaire. Entrez des limites pour les demandes totales, la limite du processeur et la limite du processeur pour la recherche, ou acceptez les limites par défaut préremplies.

1. Attendez la fin de l’exécution de la configuration. Activation des limites de taux pour Git Si un membre du personnel de GitHub l’a recommandé, vous pouvez appliquer des limites de débit Git par réseau de dépôt ou par ID utilisateur.

2. À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.

3. Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.

4. Dans la barre latérale « Site admin », cliquez sur Console de gestion.

5. Les limites de débit Git sont mesurées en opérations simultanées par minute et s’adaptent à la charge actuelle du processeur.

6. Laissez ce paramètre désactivé, sauf si cela est directement recommandé par le personnel de GitHub.

7. Les opérations Git sont rarement l’élément principal de l’utilisation du processeur et de la RAM.

8. Sous la barre latérale « Paramètres », cliquez sur Enregistrer les paramètres.

   Remarque

   L’enregistrement des paramètres dans la Console de gestion redémarre les services système, ce qui peut entraîner un temps d’arrêt visible pour l’utilisateur.

9. Attendez la fin de l’exécution de la configuration.

L’activation de cette fonctionnalité peut rendre les opérations Git plus susceptibles d’échouer sous une charge élevée, mais ne traite pas de la cause sous-jacente.

1. À partir d’un compte d’administration sur GitHub Enterprise Server, cliquez sur en haut à droite de n’importe quelle page.
2. Si vous ne figurez pas déjà sur la page « Administrateur du site », dans le coin supérieur gauche, cliquez sur Administrateur du site.
3. Dans la barre latérale « Site admin », cliquez sur Console de gestion. Sous « Limitation de débit », sélectionnez Activer la limitation de débit Git.

Sous « Limite du réseau du dépôt », tapez une limite pour chaque réseau de dépôts.

Sous « Limite d’ID utilisateur », tapez une limite pour chaque ID utilisateur. 1. Sous la barre latérale « Paramètres », cliquez sur Enregistrer les paramètres.

1. Attendez la fin de l’exécution de la configuration. Configuration des limites de débit pour GitHub Actions

Vous pouvez appliquer une limite de débit aux exécutions de workflow GitHub Actions. Pour plus d’informations sur GitHub Actions, consultez À propos de GitHub Actions pour les entreprises. À propos des limites de débit pour GitHub Actions Votre instance GitHub Enterprise Server attribue chaque GitHub Actions workflow job à un runner. Si votre instance ne peut pas affecter immédiatement un travail à un exécuteur disponible, le travail est placé en file d’attente.

Si GitHub Actions subit une charge élevée soutenue, une file d’attente peut s'accumuler et les performances de votre instance GitHub Enterprise Server peuvent se dégrader. Pour éviter cela, vous pouvez configurer une limite de débit pour GitHub Actions.

Cette limite de taux est mesurée en nombre d'exécutions de travaux par minute. GitHub Enterprise Server applique la limite de débit pour toutes les exécutions de travaux sur l’instance. Si les exécutions dépassent la limite de débit, les exécutions supplémentaires échouent au lieu d’entrer dans la file d’attente.

L'erreur suivante apparaît dans les annotations du processus d'exécution. Vous avez dépassé la limite de taux pour les demandes d’exécution de workflow. Veuillez patienter avant de réessayer l’exécution. Une bonne limitation de débit protège votre instance GitHub Enterprise Server contre des pics inhabituels d’utilisation de GitHub Actions sans interférer avec les opérations quotidiennes.

Le seuil approprié dépend des ressources disponibles de votre instance et de la charge de travail classique.

1. Connexion SSH à votre instance GitHub Enterprise Server. Si votre instance comprend plusieurs nœuds, par exemple si la haute disponibilité ou la géoréplication sont configurées, connectez-vous via SSH au nœud principal. Si vous utilisez un cluster, vous pouvez vous connecter via SSH à n’importe quel nœud. Remplacez HOSTNAME par le nom d’hôte de votre instance, le nom d’hôte ou l’adresse IP d’un nœud. Pour plus d’informations, consultez « Accès à l’interpréteur de commandes d’administration (SSH) ».

   Shell

   ssh -p 122 admin@HOSTNAME
   

2. Pour plus d’informations sur la configuration matérielle requise pour GitHub Actions, consultez Prise en main de GitHub Actions pour GitHub Enterprise Server.

   ghe-config actions-rate-limiting.enabled true
   ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE
   

3. Par défaut, la limite de débit pour GitHub Actions est désactivée.

   ghe-config actions-rate-limiting.enabled false
   

4. GitHub Enterprise Server peut gérer des pics d’utilisation temporaires sans problème, de sorte que cette limite de débit protège contre une charge élevée soutenue.

   ghe-config-apply
   

5. Laissez-le désactivé, sauf si vous rencontrez des problèmes de performances.

Dans certains cas, le Support GitHub peut recommander d’activer une limitation de débit pour GitHub Actions.

Activer ou désactiver les limites de débit pour GitHub Actions 1. Connexion SSH à votre instance GitHub Enterprise Server. Si votre instance comprend plusieurs nœuds, par exemple si la haute disponibilité ou la géoréplication sont configurées, connectez-vous via SSH au nœud principal. Si vous utilisez un cluster, vous pouvez vous connecter via SSH à n’importe quel nœud. Remplacez HOSTNAME par le nom d’hôte de votre instance, le nom d’hôte ou l’adresse IP d’un nœud. Pour plus d’informations, consultez « Accès à l’interpréteur de commandes d’administration (SSH) ».

ssh -p 122 admin@HOSTNAME

ssh -p 122 admin@HOSTNAME

Pour activer et configurer la limite de taux, exécutez les deux commandes suivantes, en remplaçant RUN-PER-MINUTE par la valeur de votre choix. Pour désactiver la limite de débit, exécutez la commande suivante. Pour appliquer la configuration, exécutez la commande suivante.

Attendez la fin de l’exécution de la configuration.