Configuration d’une instance de préproduction

Vous pouvez configurer une instance GitHub Enterprise Server dans un environnement séparé et isolé, et utiliser cette instance pour valider et tester les modifications.

Dans cet article

À propos des instances intermédiaires

GitHub vous recommande de configurer un environnement distinct pour tester les sauvegardes, les mises à jour ou les changements apportés à la configuration de votre instance GitHub Enterprise Server. Cet environnement, que vous devez isoler de vos systèmes de production, est appelé environnement intermédiaire.

Par exemple, pour vous protéger contre la perte de données, vous pouvez régulièrement valider la sauvegarde de votre instance de production. Vous pouvez régulièrement restaurer la sauvegarde de vos données de production sur une instance distincte de GitHub Enterprise Server dans un environnement intermédiaire. Sur cette instance intermédiaire, vous pouvez également tester la mise à niveau vers la dernière mise en production de fonctionnalité de GitHub Enterprise Server.

Conseil

Vous pouvez réutiliser votre fichier de licence GitHub Enterprise existant, à condition que l’instance intermédiaire ne soit pas utilisée dans une capacité de production.

Considérations relatives à un environnement intermédiaire

Pour effectuer un test approfondi de GitHub Enterprise Server et recréer un environnement aussi proche que possible de votre environnement de production, vous devez tenir compte des systèmes externes qui interagissent avec votre instance. Par exemple, vous pouvez tester les éléments suivants dans votre environnement intermédiaire.

  • Authentification, en particulier si vous utilisez un fournisseur d’authentification externe comme SAML
  • Intégration à un système de gestion de tickets externe
  • Intégration à un serveur d’intégration continue
  • Scripts ou logiciels externes qui utilisent les GitHub Enterprise Server APIs
  • Serveur SMTP externe pour les notifications par e-mail

Configuration d’une instance de préproduction

Vous pouvez configurer une instance de préproduction à partir de zéro, comme vous le souhaitez. Pour plus d’informations, consultez « Configuration d’une instance GitHub Enterprise Server » et « Configuration de GitHub Enterprise ».

Vous pouvez également créer une instance de préproduction qui reflète votre configuration de production en restaurant une sauvegarde de votre instance de production sur l’instance de préproduction.

  1. Sauvegarder votre instance de production.
  2. Configurer une instance de préproduction.
  3. Configurer GitHub Actions.
  4. Configurer GitHub Packages.
  5. Restaurer votre sauvegarde de production.
  6. Passer en revue la configuration de l’instance.
  7. Appliquer la configuration de l’instance.

1. Sauvegarder votre instance de production

Si vous souhaitez tester des changements sur une instance qui contient les mêmes données et la même configuration que votre instance de production, sauvegardez les données et la configuration de l’instance de production en utilisant GitHub Enterprise Server Backup Utilities. Pour plus d’informations, consultez « Configurer les sauvegardes sur votre instance à l’aide des Utilitaires de sauvegarde ».

Avertissement

Si vous utilisez GitHub Actions ou GitHub Packages en production, la sauvegarde inclut votre configuration de production pour le stockage externe. Pour éviter toute perte potentielle de données en écrivant sur votre stockage de production à partir de l’instance de préproduction, vous devez configurer chaque fonctionnalité aux étapes 3 et 4 avant de restaurer la sauvegarde.

2. Configurer une instance de préproduction

Configurez une nouvelle instance qui jouera le rôle d’environnement de préproduction. Lorsque vous suivez le processus de configuration, veillez à sélectionner l’option Nouvelle installation. Cela garantira que votre environnement intermédiaire est correctement initialisé et prêt à restaurer une sauvegarde si nécessaire.

Vous pouvez utiliser les mêmes guides pour le provisionnement et l’installation de votre instance de préproduction que ceux utilisés pour votre instance de production. Pour plus d’informations, consultez « Configuration d’une instance GitHub Enterprise Server ».

Si vous comptez restaurer une sauvegarde de votre instance de production, passez à l’étape suivante. Vous pouvez également configurer l’instance manuellement, et ignorer les étapes suivantes.

Avertissement

La restauration des sauvegardes avec GitHub Actions n'aboutira pas sur une instance non configurée. Pour activer GitHub Actions, une instance avec un nom d'hôte configuré est nécessaire. Pour plus d’informations, consultez « Configuration du nom d'hôte pour votre instance ».

3. Configurer GitHub Actions

Si vous utilisez GitHub Actions sur votre instance de production, configurez éventuellement la fonctionnalité sur l’instance de préproduction avant de restaurer votre sauvegarde de production. Si vous n’utilisez pas GitHub Actions, passez à Configurer GitHub Packages.

Pour configurer GitHub Actions sur votre instance intermédiaire, utilisez Management Console.

La Management Console offre une interface sécurisée basée sur un navigateur pour la configuration de bas niveau de votre instance GitHub Enterprise Server, y compris GitHub Actions. Toutes les modifications de configuration sont auditées et l’accès est protégé par des identifiants dédiés et des contrôles réseau.

Avertissement

Si vous ne configurez pas GitHub Actions sur l’instance de préproduction avant de restaurer votre sauvegarde de production, votre instance de préproduction utilise le stockage externe de votre instance de production, ce qui peut entraîner une perte de données. Nous vous recommandons vivement d’utiliser un autre stockage externe pour votre instance de préproduction. Pour plus d’informations, consultez « Utilisation d’un environnement intermédiaire ».

  1. Accédez à Management Console. Consultez Accès à la console de gestion.

  2. Dans la barre latérale, ouvrez l’onglet Actions.

  3. Activez GitHub Actions en cochant Activer GitHub Actions.

  4. Sélectionnez votre fournisseur de stockage externe pour le stockage des artefacts et des journaux.

  5. Entrez les informations de stockage et d’authentification requises pour le fournisseur choisi.

  6. Testez votre configuration en cliquant sur Tester les paramètres de stockage, puis cliquez sur Enregistrer les paramètres.

Une fois que vous avez configuré et activé GitHub Actions, passez à l’étape suivante.

4. Configurer GitHub Packages

Si vous utilisez GitHub Packages sur votre instance de production, configurez éventuellement la fonctionnalité sur l’instance de préproduction avant de restaurer votre sauvegarde de production. Si vous n’utilisez pas GitHub Packages, passez à Restaurer votre sauvegarde de production.

Avertissement

Si vous ne configurez pas GitHub Packages sur l'instance intermédiaire avant de restaurer votre sauvegarde de production, votre instance intermédiaire utilisera le stockage externe de votre instance de production, ce qui pourrait entraîner une perte de données. Nous vous recommandons vivement d’utiliser un autre stockage externe pour votre instance de préproduction. Pour plus d’informations, consultez « Utilisation d’un environnement intermédiaire ».

Pour configurer GitHub Packages pour votre instance intermédiaire :

  1. Accédez à Management Console. Consultez Accéder à la console de gestion.
  2. Dans la barre latérale, ouvrez l’onglet Packages.
  3. Activez GitHub Packages en cochant la case Activer GitHub Packages.
  4. Sous Paramètres de stockage des packages, sélectionnez votre fournisseur de stockage externe.
  5. Testez votre configuration de stockage en cliquant sur Tester les paramètres de stockage.
  6. Cliquez sur Enregistrer les paramètres pour appliquer votre configuration.

Remarque

Vous pouvez utiliser les boutons de basculement de l’écosystème pour activer, désactiver ou définir des types de packages individuels en lecture seule pour votre instance, selon vos besoins.

5. Restaurer votre sauvegarde de production

Utilisez la commande ghe-restore pour restaurer le reste des données à partir de la sauvegarde. Pour plus d’informations, consultez « Configurer les sauvegardes sur votre instance à l’aide des Utilitaires de sauvegarde ».

Si l’instance de préproduction est déjà configurée et si vous souhaitez remplacer les paramètres, le certificat et les données de licence, ajoutez l’option -c à la commande. Pour plus d’informations sur l’option, consultez Utilisation des commandes de sauvegarde et de restauration dans la documentation de GitHub Enterprise Server Backup Utilities.

6. Passer en revue la configuration de l’instance

Pour accéder à l’instance de préproduction à l’aide du même nom d’hôte, mettez à jour votre fichier d’hôtes local afin de résoudre le nom d’hôte de l’instance de préproduction en fonction de l’adresse IP en modifiant le fichier /etc/hosts sur macOS ou Linux, ou le fichier C:\Windows\system32\drivers\etc sur Windows.

Remarque

Votre instance de préproduction doit être accessible à partir du même nom d’hôte que votre instance de production. Le changement de nom d’hôte pour votre instance GitHub Enterprise Server n’est pas pris en charge. Pour plus d’informations, consultez « Configuration du nom d'hôte pour votre instance ».

Passez ensuite en revue la configuration de l’instance de préproduction dans Management Console. Pour plus d’informations, consultez « Géstion de votre instance à partir de l’IU WEB. ».

Avertissement

Si vous avez configuré GitHub Actions ou GitHub Packages pour l’instance de préproduction, et si vous souhaitez éviter de remplacer les données de production, vérifiez que la configuration du stockage externe dans la Management Console ne correspond pas à votre instance de production.

7. Appliquer la configuration de l’instance

Pour appliquer la configuration à partir de la Management Console, cliquez sur Enregistrer les paramètres.

Retour en ligne d’un instance intermédiaire

Vous souhaiterez peut-être éteindre une instance intermédiaire pour économiser les coûts et la réactiver si nécessaire.

Une instance peut rester hors connexion pendant 60 jours.

Si vous rétablissez l’instance en ligne au cours de la période de temps hors connexion autorisée, GitHub Enterprise Server instancie correctement. Si l’instance reste hors connexion pendant plus longtemps que la période autorisée, GitHub Enterprise Server ne parvient pas à instancier correctement et un message d’erreur avec le texte server has been offline for more than the configured server_rejoin_age_max peut apparaître dans les journaux système. Consultez À propos des journaux système.

Si l’instance est bloquée dans l’état d’erreur, vous pouvez exécuter ces commandes pour récupérer.

sudo mv /data/user/consul/server_metadata.json /data/user/consul/server_metadata.json.bak
ghe-config-apply

Pour aller plus loin