# Redis-Service-Container erstellen

Du kannst Service-Container verwenden, um einen Redis-Client in Deinem Workflow zu erstellen. Dieser Leitfaden zeigt Beispiele für die Erstellung eines Redis-Dienstes für Jobs, die in Containern oder direkt auf der Runner-Maschine ausgeführt werden.

## Einführung

Dieser Leitfaden zeigt Ihnen Workflowbeispiele, die einen Servercontainer mithilfe des Docker-Hub-Images `redis` konfigurieren. Der Workflow führt ein Skript aus, um einen Redis-Client zu erstellen und den Client mit Daten zu füllen. Um zu testen, ob der Workflow den Redis-Client erstellt und mit Daten füllt, gibt das Skript die Daten des Clients auf der Konsole aus.

> \[!NOTE]
> Wenn bei deinen Workflows Docker-Containeraktionen, Auftragscontainer oder Dienstcontainer verwendet werden, musst du einen Linux-Runner nutzen:
>
> * Wenn du GitHub-gehostete Runner verwendest, musst du einen Ubuntu-Runner verwenden.
> * Wenn du selbst gehostete Läufer verwendest, musst du einen Linux-Rechner als deinen Läufer verwenden und Docker muss installiert sein.

## Voraussetzungen

Sie sollten mit dem Zusammenspiel von Dienstcontainern mit GitHub Actions und den Netzwerkunterschieden zwischen dem direkten Ausführen von Jobs auf dem Runner und dem Ausführen in einem Container vertraut sein. Weitere Informationen finden Sie unter [Kommunizieren mit Docker-Dienstcontainern](/de/actions/tutorials/use-containerized-services/use-docker-service-containers).

Möglicherweise ist es auch hilfreich, ein grundlegendes Verständnis von YAML, der Syntax für GitHub Actionsund Redis zu haben. Weitere Informationen finden Sie unter:

* [Schreiben von Workflows](/de/actions/how-tos/write-workflows)
* [Erste Schritte mit Redis](https://redis.io/learn/howtos/quick-start) in der Redis-Dokumentation

## Jobs in Containern ausführen

Das Konfigurieren von Aufträgen für die Ausführung in einem Container vereinfacht die Netzwerkkonfigurationen zwischen dem Auftrag und den Dienstcontainern. Docker-Container im gleichen benutzerdefinierten Bridge-Netzwerk exponieren gegenseitig alle Ports, sodass Du keinen der Servicecontainer-Ports dem Docker-Host zuordnen musst. Mit der im Workflow konfigurierten Kennzeichnung kannst Du vom Auftrags-Container her auf den Dienst-Container zugreifen.

Du kannst diese Workflowdatei in das `.github/workflows`-Verzeichnis deines Repositorys kopieren und nach Bedarf ändern.

```yaml copy
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@v6

      # 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
```

### Den Container-Job konfigurieren

Dieser Workflow konfiguriert einen Auftrag, der im Container `node:20-bookworm-slim` ausgeführt wird, und nutzt den  GitHub-gehosteten Runner `ubuntu-latest` als Docker-Host für den Container. Weitere Informationen zum Container `node:20-bookworm-slim` findest Du im [Knotenimage](https://hub.docker.com/_/node) auf Docker Hub.

Der Workflow konfiguriert einen Dienstcontainer mit der Bezeichnung `redis`. Alle Dienste müssen in einem Container ausgeführt werden, daher erfordert jeder Dienst die Angabe des Containers `image`. Dieses Beispiel verwendet das `redis`-Containerimage und enthält Optionen für Integritätsüberprüfungen, um die Ausführung des Diensts sicherzustellen. Füge dem Imagenamen ein Tag an, um eine Version anzugeben, z. B. `redis:6`. Weitere Informationen findest du im [Redis-Image](https://hub.docker.com/_/redis) für Docker Hub.

```yaml copy
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
```

### Konfigurieren der Schritte für den Containerauftrag

Der Workflow führt die folgenden Schritte aus:

1. Auschecken des Repository auf dem Läufer
2. Installieren von Abhängigkeiten
3. Ausführen eines Script, um einen Client zu erstellen

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

  # 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
```

Das *client.js*-Skript sucht nach den Umgebungsvariablen `REDIS_HOST` und `REDIS_PORT`, um den Client zu erstellen. Der Workflow legt diese beiden Umgebungsvariablen im Rahmen des Schritts „Mit Redis verbinden“ fest, um sie dem *client.js*-Skript zur Verfügung zu stellen. Weitere Informationen zum Skript findest du unter [Testen des Redis-Dienstcontainers](#testing-the-redis-service-container).

Der Hostname des Redis-Diensts ist die Bezeichnung, die du in deinem Workflow konfiguriert hast (in diesem Fall: `redis`). Da Docker-Container im selben benutzerdefinierten Bridge-Netzwerk standardmäßig alle Ports öffnen, kannst Du auf den Service-Container über den Standard-Redis-Port 6379 zugreifen.

## Jobs direkt auf der Runner-Maschine ausführen

Wenn Du einen Job direkt auf der Runner-Maschine ausführst, musst Du die Ports des Service-Containers den Ports des Docker-Hosts zuordnen. Du kannst vom Docker-Host aus auf Dienstcontainer zugreifen, indem du `localhost` und die Portnummer des Docker-Hosts verwendest.

Du kannst diese Workflowdatei in das `.github/workflows`-Verzeichnis deines Repositorys kopieren und nach Bedarf ändern.

```yaml copy
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@v6

      # 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
```

### Runner-Job konfigurieren

Im Beispiel wird der  GitHub-gehostete Runner `ubuntu-latest` als Docker-Host verwendet.

Der Workflow konfiguriert einen Dienstcontainer mit der Bezeichnung `redis`. Alle Dienste müssen in einem Container ausgeführt werden, daher erfordert jeder Dienst die Angabe des Containers `image`. Dieses Beispiel verwendet das `redis`-Containerimage und enthält Optionen für Integritätsüberprüfungen, um die Ausführung des Diensts sicherzustellen. Füge dem Imagenamen ein Tag an, um eine Version anzugeben, z. B. `redis:6`. Weitere Informationen findest du im [Redis-Image](https://hub.docker.com/_/redis) für Docker Hub.

Der Workflow ordnet Port 6379 des Redis-Service-Containers dem Docker-Host zu. Weitere Informationen zum Schlüsselwort `ports` findest du unter [Kommunizieren mit Docker-Dienstcontainern](/de/actions/tutorials/use-containerized-services/use-docker-service-containers#mapping-docker-host-and-service-container-ports).

```yaml copy
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
```

### Konfigurieren der Schritte für den Runner-Job

Der Workflow führt die folgenden Schritte aus:

1. Auschecken des Repository auf dem Läufer
2. Installieren von Abhängigkeiten
3. Ausführen eines Script, um einen Client zu erstellen

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

  # 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
```

Das *client.js*-Skript sucht nach den Umgebungsvariablen `REDIS_HOST` und `REDIS_PORT`, um den Client zu erstellen. Der Workflow legt diese beiden Umgebungsvariablen im Rahmen des Schritts „Mit Redis verbinden“ fest, um sie dem *client.js*-Skript zur Verfügung zu stellen. Weitere Informationen zum Skript findest du unter [Testen des Redis-Dienstcontainers](#testing-the-redis-service-container).

Der Hostname ist `localhost` oder `127.0.0.1`.

## Redis-Service-Container testen

Du kannst Deinen Workflow mit dem folgenden Skript testen, das einen Redis-Client erstellt und den Client mit Platzhalter-Daten füllt. Das Skript gibt dann die im Redis-Client gespeicherten Werte auf dem Terminal aus. Für das Skript kann eine beliebige Sprache verwendet werden. In diesem Beispiel werden jedoch Node.js und das npm-Modul `redis` genutzt. Weitere Informationen findest du unter dem [npm-Modul „redis“](https://www.npmjs.com/package/redis).

Du kannst *client.js* anpassen, um alle Redis-Vorgänge einzuschließen, die für deinen Workflow erforderlich sind. In diesem Beispiel erstellt das Skript die Redis-Client-Instanz, fügt Platzhalter-Daten hinzu und ruft dann die Daten ab.

Füge deinem Repository eine neue Datei namens *client.js* mit dem folgenden Code hinzu.

```javascript copy
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
  }
})();
```

Das Skript erstellt einen neuen Redis-Client mithilfe der Methode `createClient`. Diese Methode akzeptiert einen Parameter vom Typ `host` und einen Parameter vom Typ `port`. Im Skript werden die Umgebungsvariablen `REDIS_HOST` und `REDIS_PORT` verwendet, um die IP-Adresse und den Port des Clients festzulegen. Wenn `host` und `port` nicht definiert sind, werden der Standardhost `localhost` und der Standardport 6379 verwendet.

Im Skript werden die Methoden `set` und `hset` verwendet, um die Datenbank mit einigen Schlüsseln, Feldern und Werten aufzufüllen. Um zu bestätigen, dass der Redis-Client die Daten enthält, gibt das Skript den Inhalt der Datenbank in das Konsolen-Log aus.

Wenn Du diesen Workflow ausführst, solltest Du im Schritt „Mit Redis verbinden“ die folgende Ausgabe sehen, welche zeigt, dass Du den Redis-Client erstellt und Daten hinzugefügt hast:

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