Skip to main content
We publish frequent updates to our documentation, and translation of this page may still be in progress. For the most current information, please visit the English documentation.

Cette version de GitHub Enterprise a été abandonnée le 2023-01-18. Aucune publication de correctifs n’est effectuée, même pour les problèmes de sécurité critiques. Pour de meilleures performances, une sécurité améliorée et de nouvelles fonctionnalités, effectuez une mise à niveau vers la dernière version de GitHub Enterprise. Pour obtenir de l’aide sur la mise à niveau, contactez le support GitHub Enterprise.

Création de conteneurs de service Redis

Vous pouvez utiliser les conteneurs de services pour créer un client Redis dans votre workflow. Ce guide présente des exemples de création d’un service Redis pour les travaux qui s’exécutent dans des conteneurs ou directement sur la machine de l’exécuteur.

Remarque : Les exécuteurs hébergés sur GitHub ne sont pas pris en charge sur GitHub Enterprise Server. Vous pouvez voir plus d’informations sur le support futur planifié dans la GitHub public roadmap.

Introduction

Ce guide présente des exemples de workflow qui configurent un conteneur de service à l’aide de l’image Docker Hub redis. Le workflow exécute un script pour créer un client Redis et renseigner le client avec des données. Pour tester que le workflow crée et renseigne le client Redis, le script affiche les données du client dans la console.

Remarque : Si vos workflows utilisent des actions de conteneur Docker, des conteneurs de travaux ou des conteneurs de services, vous devez utiliser un exécuteur Linux :

  • Si vous utilisez des exécuteurs hébergés sur GitHub, vous devez utiliser un exécuteur Ubuntu.
  • Si vous utilisez des exécuteurs autohébergés, vous devez utiliser une machine Linux en tant qu’exécuteur, et Docker doit être installé.

Prérequis

Vous devez connaître le fonctionnement des conteneurs de service avec GitHub Actions et les différences de réseau entre une exécution directe des travaux sur l’exécuteur ou dans un conteneur. Pour plus d’informations, consultez « À propos des conteneurs de service ».

Vous pouvez également trouver utile de disposer d’une connaissance élémentaire de YAML, de la syntaxe de GitHub Actions et de Redis. Pour plus d'informations, consultez les pages suivantes :

Exécution de travaux dans des conteneurs

La configuration de travaux à exécuter dans un conteneur simplifie la mise en réseau des configurations entre le travail et les conteneurs de service. Les conteneurs Docker d’un même réseau de pont défini par l’utilisateur exposent tous les ports les uns aux autres. Vous n’avez donc pas besoin de mapper les ports des conteneurs de service à l’hôte Docker. Vous pouvez accéder au conteneur de service à partir du conteneur de travaux à l’aide de l’étiquette que vous configurez dans le workflow.

Vous pouvez copier ce fichier de workflow dans le répertoire .github/workflows de votre dépôt et le modifier selon vos besoins.

YAML
name: Redis container example
on: push

jobs:
  # Label of the container job
  container-job:
    # Containers must run in Linux based operating systems
    runs-on: ubuntu-latest
    # Docker Hub image that `container-job` executes in
    container: node:10.18-jessie

    # Service containers to run with `container-job`
    services:
      # Label used to access the service container
      redis:
        # Docker Hub image
        image: redis
        # Set health checks to wait until redis has started
        options: >-
          --health-cmd "redis-cli ping"
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

    steps:
      # Downloads a copy of the code in your repository before running CI tests
      - name: Check out repository code
        uses: actions/checkout@v2

      # Performs a clean installation of all dependencies in the `package.json` file
      # For more information, see https://docs.npmjs.com/cli/ci.html
      - name: Install dependencies
        run: npm ci

      - name: Connect to Redis
        # Runs a script that creates a Redis client, populates
        # the client with data, and retrieves data
        run: node client.js
        # Environment variable used by the `client.js` script to create a new Redis client.
        env:
          # The hostname used to communicate with the Redis service container
          REDIS_HOST: redis
          # The default Redis port
          REDIS_PORT: 6379

Configuration du travail de conteneur

Ce workflow configure un travail qui s’exécute dans le conteneur node:10.18-jessie et qui utilise ubuntu-latest, l’exécuteur hébergé sur GitHub en tant qu’hôte Docker pour le conteneur. Pour plus d’informations sur le conteneur node:10.18-jessie, consultez l’image node sur Docker Hub.

Le workflow configure un conteneur de service avec l’étiquette redis. Tous les services devant s’exécuter dans un conteneur, chaque service exige que vous spécifiiez le conteneur image. Cet exemple utilise l’image conteneur redis et inclut des options de vérification de l’intégrité pour s’assurer que le service est en cours d’exécution. Pour plus d’informations, consultez image redis sur Docker Hub.

YAML
jobs:
  # Label of the container job
  container-job:
    # Containers must run in Linux based operating systems
    runs-on: ubuntu-latest
    # Docker Hub image that `container-job` executes in
    container: node:10.18-jessie

    # Service containers to run with `container-job`
    services:
      # Label used to access the service container
      redis:
        # Docker Hub image
        image: redis
        # Set health checks to wait until redis has started
        options: >-
          --health-cmd "redis-cli ping"
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5

Configuration des étapes

Le workflow effectue les étapes suivantes :

  1. Il extrait le dépôt sur l’exécuteur.
  2. Il installe des dépendances.
  3. Il exécute un script pour créer un client.
YAML
steps:
  # Downloads a copy of the code in your repository before running CI tests
  - name: Check out repository code
    uses: actions/checkout@v2

  # Performs a clean installation of all dependencies in the `package.json` file
  # For more information, see https://docs.npmjs.com/cli/ci.html
  - name: Install dependencies
    run: npm ci

  - name: Connect to Redis
    # Runs a script that creates a Redis client, populates
    # the client with data, and retrieves data
    run: node client.js
    # Environment variable used by the `client.js` script to create a new Redis client.
    env:
      # The hostname used to communicate with the Redis service container
      REDIS_HOST: redis
      # The default Redis port
      REDIS_PORT: 6379

Le script client.js recherche les variables d’environnement REDIS_HOST et REDIS_PORT pour créer le client. Le workflow définit ces deux variables d’environnement dans le cadre de l’étape « Se connecter à Redis » pour les rendre disponibles pour le script client.js. Pour plus d’informations sur le script, consultez « Test du conteneur de service Redis ».

Le nom d’hôte du service Redis est l’étiquette que vous avez configurée dans votre workflow ; dans le cas présent, redis. Étant donné que les conteneurs Docker se trouvant sur le même réseau de pont défini par l’utilisateur ouvrent tous les ports par défaut, vous pourrez accéder au conteneur de service sur le port Redis par défaut 6379.

Exécution de travaux directement sur la machine de l’exécuteur

Lorsque vous exécutez un travail directement sur la machine de l’exécuteur, vous devez mapper les ports du conteneur de service aux ports sur l’hôte Docker. Vous pouvez accéder aux conteneurs de service à partir de l’hôte Docker à l’aide de localhost et du numéro de port de l’hôte Docker.

Vous pouvez copier ce fichier de workflow dans le répertoire .github/workflows de votre dépôt et le modifier selon vos besoins.

YAML
name: Redis runner example
on: push

jobs:
  # Label of the runner job
  runner-job:
    # You must use a Linux environment when using service containers or container jobs
    runs-on: ubuntu-latest

    # Service containers to run with `runner-job`
    services:
      # Label used to access the service container
      redis:
        # Docker Hub image
        image: redis
        # Set health checks to wait until redis has started
        options: >-
          --health-cmd "redis-cli ping"
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
        ports:
          # Maps port 6379 on service container to the host
          - 6379:6379

    steps:
      # Downloads a copy of the code in your repository before running CI tests
      - name: Check out repository code
        uses: actions/checkout@v2

      # Performs a clean installation of all dependencies in the `package.json` file
      # For more information, see https://docs.npmjs.com/cli/ci.html
      - name: Install dependencies
        run: npm ci

      - name: Connect to Redis
        # Runs a script that creates a Redis client, populates
        # the client with data, and retrieves data
        run: node client.js
        # Environment variable used by the `client.js` script to create
        # a new Redis client.
        env:
          # The hostname used to communicate with the Redis service container
          REDIS_HOST: localhost
          # The default Redis port
          REDIS_PORT: 6379

Configuration du travail de l’exécuteur

L’exemple utilise ubuntu-latest, l’exécuteur hébergé sur GitHub, en tant qu’hôte Docker.

Le workflow configure un conteneur de service avec l’étiquette redis. Tous les services devant s’exécuter dans un conteneur, chaque service exige que vous spécifiiez le conteneur image. Cet exemple utilise l’image conteneur redis et inclut des options de vérification de l’intégrité pour s’assurer que le service est en cours d’exécution. Pour plus d’informations, consultez image redis sur Docker Hub.

Le workflow mappe le port 6379 sur le conteneur de service Redis à l’hôte Docker. Pour plus d’informations sur le mot clé ports, consultez « À propos des conteneurs de service ».

YAML
jobs:
  # Label of the runner job
  runner-job:
    # You must use a Linux environment when using service containers or container jobs
    runs-on: ubuntu-latest

    # Service containers to run with `runner-job`
    services:
      # Label used to access the service container
      redis:
        # Docker Hub image
        image: redis
        # Set health checks to wait until redis has started
        options: >-
          --health-cmd "redis-cli ping"
          --health-interval 10s
          --health-timeout 5s
          --health-retries 5
        ports:
          # Maps port 6379 on service container to the host
          - 6379:6379

Configuration des étapes

Le workflow effectue les étapes suivantes :

  1. Il extrait le dépôt sur l’exécuteur.
  2. Il installe des dépendances.
  3. Il exécute un script pour créer un client.
YAML
steps:
  # Downloads a copy of the code in your repository before running CI tests
  - name: Check out repository code
    uses: actions/checkout@v2

  # Performs a clean installation of all dependencies in the `package.json` file
  # For more information, see https://docs.npmjs.com/cli/ci.html
  - name: Install dependencies
    run: npm ci

  - name: Connect to Redis
    # Runs a script that creates a Redis client, populates
    # the client with data, and retrieves data
    run: node client.js
    # Environment variable used by the `client.js` script to create
    # a new Redis client.
    env:
      # The hostname used to communicate with the Redis service container
      REDIS_HOST: localhost
      # The default Redis port
      REDIS_PORT: 6379

Le script client.js recherche les variables d’environnement REDIS_HOST et REDIS_PORT pour créer le client. Le workflow définit ces deux variables d’environnement dans le cadre de l’étape « Se connecter à Redis » pour les rendre disponibles pour le script client.js. Pour plus d’informations sur le script, consultez « Test du conteneur de service Redis ».

Le nom d’hôte est localhost ou 127.0.0.1.

Test du conteneur de service Redis

Vous pouvez tester votre workflow à l’aide du script suivant, qui crée un client Redis et renseigne le client avec des données d’espace réservé. Le script affiche ensuite les valeurs stockées dans le client Redis dans le terminal. Votre script peut utiliser n’importe quel langage souhaité, mais cet exemple utilise Node.js et le module npm redis. Pour plus d’informations, consultez le module npm Redis.

Vous pouvez modifier client.js pour inclure toutes les opérations Redis nécessaires à votre workflow. Dans cet exemple, le script crée l’instance de client Redis, ajoute des données d’espace réservé, puis récupère les données.

Ajoutez un nouveau fichier appelé client.js à votre dépôt avec le code suivant.

JavaScript
const redis = require("redis");

// Creates a new Redis client
// If REDIS_HOST is not set, the default host is localhost
// If REDIS_PORT is not set, the default port is 6379
const redisClient = redis.createClient({
  host: process.env.REDIS_HOST,
  port: process.env.REDIS_PORT  
});

redisClient.on("error", function(err) {
    console.log("Error " + err);
});

// Sets the key "octocat" to a value of "Mona the octocat"
redisClient.set("octocat", "Mona the Octocat", redis.print);
// Sets a key to "octocat", field to "species", and "value" to "Cat and Octopus"
redisClient.hset("species", "octocat", "Cat and Octopus", redis.print);
// Sets a key to "octocat", field to "species", and "value" to "Dinosaur and Octopus"
redisClient.hset("species", "dinotocat", "Dinosaur and Octopus", redis.print);
// Sets a key to "octocat", field to "species", and "value" to "Cat and Robot"
redisClient.hset(["species", "robotocat", "Cat and Robot"], redis.print);
// Gets all fields in "species" key

redisClient.hkeys("species", function (err, replies) {
    console.log(replies.length + " replies:");
    replies.forEach(function (reply, i) {
        console.log("    " + i + ": " + reply);
    });
    redisClient.quit();
});

Le script crée un client Redis à l’aide de la méthode createClient, qui accepte un paramètre host et port. Le script utilise les variables d’environnement REDIS_HOST et REDIS_PORT pour définir l’adresse IP et le port du client. Si host et port ne sont pas définis, l’hôte par défaut est localhost et le port par défaut est 6379.

Le script utilise les méthodes set et hset pour remplir la base de données avec des clés, des champs et des valeurs. Pour confirmer que le client Redis contient les données, le script imprime le contenu de la base de données dans le journal de la console.

Lorsque vous exécutez ce workflow, vous devez voir la sortie suivante dans l’étape « Se connecter à Redis », confirmant que vous avez créé le client Redis et ajouté des données :

Reply: OK
Reply: 1
Reply: 1
Reply: 1  
3 replies:
    0: octocat
    1: dinotocat
    2: robotocat