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 :
- « Écriture de workflows »
- « Bien démarrer avec Redis » dans la documentation Redis
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.
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:20-bookworm-slim
# 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@v4
# 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
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:20-bookworm-slim
# 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@v4
# 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 flux de travail configure un travail qui s'exécute dans le conteneur node:20-bookworm-slim et utilise l'exécuteur ubuntu-latest GitHub-hosted comme hôte Docker pour le conteneur. Pour plus d’informations sur le conteneur node:20-bookworm-slim, 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. Ajoutez une étiquette au nom de l’image qui spécifie une version, par exemple redis:6. Pour plus d’informations, consultez image redis sur Docker Hub.
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:20-bookworm-slim
# 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
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:20-bookworm-slim
# 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 pour le travail de conteneur
Le workflow effectue les étapes suivantes :
- Il extrait le dépôt sur l’exécuteur.
- Il installe des dépendances.
- Il exécute un script pour créer un client.
steps:
# Downloads a copy of the code in your repository before running CI tests
- name: Check out repository code
uses: actions/checkout@v4
# 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
steps:
# Downloads a copy of the code in your repository before running CI tests
- name: Check out repository code
uses: actions/checkout@v4
# 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.
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@v4
# 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
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@v4
# 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 s'appuie sur l'exécuteur ubuntu-latest GitHub-hosted 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. Ajoutez une étiquette au nom de l’image qui spécifie une version, par exemple redis:6. 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 ».
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
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 pour le travail d’exécuteur
Le workflow effectue les étapes suivantes :
- Il extrait le dépôt sur l’exécuteur.
- Il installe des dépendances.
- Il exécute un script pour créer un client.
steps:
# Downloads a copy of the code in your repository before running CI tests
- name: Check out repository code
uses: actions/checkout@v4
# 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
steps:
# Downloads a copy of the code in your repository before running CI tests
- name: Check out repository code
uses: actions/checkout@v4
# 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.
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({
url: `redis://${process.env.REDIS_HOST}:${process.env.REDIS_PORT}`
});
redisClient.on("error", (err) => console.log("Error", err));
(async () => {
await redisClient.connect();
// Sets the key "octocat" to a value of "Mona the octocat"
const setKeyReply = await redisClient.set("octocat", "Mona the Octocat");
console.log("Reply: " + setKeyReply);
// Sets a key to "species", field to "octocat", and "value" to "Cat and Octopus"
const SetFieldOctocatReply = await redisClient.hSet("species", "octocat", "Cat and Octopus");
console.log("Reply: " + SetFieldOctocatReply);
// Sets a key to "species", field to "dinotocat", and "value" to "Dinosaur and Octopus"
const SetFieldDinotocatReply = await redisClient.hSet("species", "dinotocat", "Dinosaur and Octopus");
console.log("Reply: " + SetFieldDinotocatReply);
// Sets a key to "species", field to "robotocat", and "value" to "Cat and Robot"
const SetFieldRobotocatReply = await redisClient.hSet("species", "robotocat", "Cat and Robot");
console.log("Reply: " + SetFieldRobotocatReply);
try {
// Gets all fields in "species" key
const replies = await redisClient.hKeys("species");
console.log(replies.length + " replies:");
replies.forEach((reply, i) => {
console.log(" " + i + ": " + reply);
});
await redisClient.quit();
}
catch (err) {
// statements to handle any exceptions
}
})();
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({
url: `redis://${process.env.REDIS_HOST}:${process.env.REDIS_PORT}`
});
redisClient.on("error", (err) => console.log("Error", err));
(async () => {
await redisClient.connect();
// Sets the key "octocat" to a value of "Mona the octocat"
const setKeyReply = await redisClient.set("octocat", "Mona the Octocat");
console.log("Reply: " + setKeyReply);
// Sets a key to "species", field to "octocat", and "value" to "Cat and Octopus"
const SetFieldOctocatReply = await redisClient.hSet("species", "octocat", "Cat and Octopus");
console.log("Reply: " + SetFieldOctocatReply);
// Sets a key to "species", field to "dinotocat", and "value" to "Dinosaur and Octopus"
const SetFieldDinotocatReply = await redisClient.hSet("species", "dinotocat", "Dinosaur and Octopus");
console.log("Reply: " + SetFieldDinotocatReply);
// Sets a key to "species", field to "robotocat", and "value" to "Cat and Robot"
const SetFieldRobotocatReply = await redisClient.hSet("species", "robotocat", "Cat and Robot");
console.log("Reply: " + SetFieldRobotocatReply);
try {
// Gets all fields in "species" key
const replies = await redisClient.hKeys("species");
console.log(replies.length + " replies:");
replies.forEach((reply, i) => {
console.log(" " + i + ": " + reply);
});
await redisClient.quit();
}
catch (err) {
// statements to handle any exceptions
}
})();
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