Einführung
Diese Anleitung zeigt Dir Workflow-Beispiele, die einen Service-Container mit dem postgres-Bild vom Docker-Hub konfigurieren. Der Workflow führt ein Skript aus, um einen PostgreSQL-Client zu erstellen und den Client mit Daten zu füllen. Um zu testen, ob der Workflow den PostgreSQL-Client erstellt und mit Daten füllt, gibt das Skript die Daten des Clients in der Konsole aus.
Hinweis: Wenn Deine Workflows Docker-Containeraktionen oder Dienstcontainer verwenden, musst Du einen Linux-Läufer verwenden:
- If you are using GitHub-hosted runners, you must use an Ubuntu runner.
- Wenn Du selbst gehostete Läufer verwendest, musst Du einen Linux-Rechner als Deinen Läufer verwenden und Docker muss installiert sein.
Vorrausetzungen
Du solltest damit vertraut sein, wie Service-Container mit GitHub Actions arbeiten und die Netzwerkunterschiede kennen zwischen dem Laufen lassen von Aufträgen direkt auf dem Läufer oder in einem Container. Weitere Informationen findest Du unter "Über Service-Container."
Es kann Dir auch helfen, YAML, die Syntax für GitHub Actions und PostgreSQL grundlegende zu verstehen. Weitere Informationen findest Du unter:
- "Learn GitHub Actions"
- "PostgreSQL-Tutorial" in der PostgreSQL-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 Workflow-Datei in das .github/workflows Verzeichnis Deines Repository kopieren und nach Bedarf verändern.
name: PostgreSQL service example
on: push
jobs:
# Label des Container-Jobs
container-job:
# Container muessen auf Linux-basierten Betriebssystemen laufen
runs-on: ubuntu-latest
# Docker-Hub-Image, welches `container-job` in
container: node:10.18-jessie ausfuehrt
# Service-Containers, der mit Diensten von `container-job`
laufen soll:
# Label fuer den Zugrieff auf den Service-Container
postgres:
# Docker-Hub-Image
image: postgres
# Das Passwort fuer Postgres bereitstellen
env:
POSTGRES_PASSWORD: postgres
# health checks (Gesundheitstests) so einstellen, dass sie warten, bis Postgres gestarted ist
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
steps:
# Laedt eine Kopie des Codes in Dein Repository herunter, bevor CI-Tests starten
- name: Check out repository code
uses: actions/checkout@v2
# Fuehrt eine saubere Installation aller Abhaengigkeiten in der Datei `package.json` durch
# Weitere Information findest Du unter https://docs.npmjs.com/cli/ci.html
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Startet ein Skript, das einen PostgreSQL-Client erzeugt,
# Den Client mit Daten befuellt, und Daten abruft
run: node client.js
# Umgebungsvariable, die vom Skript `client.js` benutzt wird, um einen neuen PostgreSQL-Client zu erzeugen.
env:
# Der Name des Hosts fuer die Kommunikation mit dem PostgreSQL-Servicecontainer
POSTGRES_HOST: postgres
# The default PostgreSQL port
POSTGRES_PORT: 5432
Runner-Job konfigurieren
Dieser Workflow konfiguriert einen Auftrag, der im node:10.18-jessie Container läuft und benutzt den ubuntu-latest GitHub-gehosteten Läufer als Docker-Host für den Container. Weitere Informationen zum node:10.18-jessie Container findest Du unter Knotenabbild auf „Docker Hub".
Der Workflow konfiguriert einen Servicecontainer mit der Kennzeichnung postgres. Alle Dienste müssen in einem Container ausgeführt werden, daher erfordert jeder Dienst, dass Du den Container image angibst. Dieses Beispiel verwendet das postgres Containerbild, stellt das standardmäßige PostgreSQL-Passwort bereit und enthält Optionen für Systemdiagnosen, um sicherzustellen, dass der Dienst ausgeführt wird. Weitere Informationen findest Du im postgres image auf „Docker Hub".
jobs:
# Label des Container-Jobs
container-job:
# Container muessen in Linux-basierten Betriebssystemen laufen
runs-on: ubuntu-latest
# Docker-Hub-Image, das `container-job` in
container: node:10.18-jessie ausfuehrt
# Service-Container, die mit `container-job` laufen sollen
services:
# Label fuer den Zugriff auf den Service-Container
postgres:
# Docker-Hub-Image
image: postgres
# Passwort fuer postgres bereitstellen
env:
POSTGRES_PASSWORD: postgres
# Health checks so einstellen, dass sie warten, bis Postgres gestarted ist
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
„Steps“ (Schritte) konfigurieren
Der Workflow führt die folgenden Schritte aus:
- Auschecken des Repository auf dem Läufer
- Installieren von Abhängigkeiten
- Ausführen eines Script, um einen Client zu erstellen
steps:
# Laedt eine Kopie des Codes in Dein Repository herunter, bevor CI-Tests starten
- name: Check out repository code
uses: actions/checkout@v2
# Fuehrt eine saubere Installation aller Anhängigkeiten in der Datei `package.json` durch
# Weitere Informationen findest Du unter https://docs.npmjs.com/cli/ci.html
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Startet ein Skript, das einen PostgreSQL-Client erzeugt,
# den Client mit Daten befuellt und Daten abruft
run: node client.js
# Environment variable used by the `client.js` script to create
# a new PostgreSQL client.
env:
# Der Name des Hosts fuer die Kommunikation mit dem PostgreSQL-Servicecontainer
POSTGRES_HOST: postgres
# Der standardmaessige PostgreSQL-Port
POSTGRES_PORT: 5432
Das Client.js-Skript sucht nach den POSTGRES_HOST und POSTGRES_PORT Umgebungsvariablen, um den Client zu erstellen. Der Workflow legt diese beiden Umgebungsvariablen als Teil des Schritts "Mit PostgreSQL verbinden" fest, um sie dem client.js-Skript zur Verfügung zu stellen. Weitere Informationen zum Skript findest Du unter "Testen des PostgreSQL-Dienstcontainers."
Der Hostname des PostgreSQL-Dienstes ist der Label, den Du in Deinem Workflow konfiguriert hast, in diesem Fall postgres. Da Docker-Container im gleichen benutzerdefinierten Bridge-Netzwerk standardmäßig alle Ports öffnen, kannst Du auf den Service-Container durch den standardmäßigen PostgreSQL-Port 5432 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 über den Docker-Host auf den Service-Container zugreifen, indem Du localhost und die Port-Nummer des Docker-Hosts verwendest.
Du kannst diese Workflow-Datei in das .github/workflows Verzeichnis Deines Repository kopieren und nach Bedarf verändern.
name: PostgreSQL Service Example
on: push
jobs:
# Label des Runner-Jobs
runner-job:
# Du musst fuer Service-Container oder Container-Jobs eine Linux-Umgebung verwenden
runs-on: ubuntu-latest
# Service-Container zum Betrieb mit `runner-job`
services:
# Label fuer den Zugriff auf den Service-Container
postgres:
# Docker-Hub-Image
image: postgres
# Das Passwort fuer Postgres bereitstellen
env:
POSTGRES_PASSWORD: postgres
# Health checks einstellen, dass sie warten, bis Postgres gestarted ist
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
# Maps tcp port 5432 on service container to the host
- 5432:5432
steps:
# Laedt eine Kopie des Codes in Dein Repository herunter, bevor CI tests laufen
- name: Check out repository code
uses: actions/checkout@v2
# Fuehrt eine saubere Installation aller Abhaengigkeiten in der Datei `package.json` durch
# Weitere Information finsest Du unter https://docs.npmjs.com/cli/ci.html
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Startet ein Skript, das einen PostgreSQL-Client erzeugt,
# den client mit Daten befuellt und Daten abruft
run: node client.js
# Umgebungsvariable, die das Skript `client.js` benutzt, um
# einen neuen PostgreSQL-Client zu erzeugen.
env:
# Der Hostname fuer die Kommunikation mit dem PostgreSQL-Service-Container
POSTGRES_HOST: localhost
# Standardmaessiger PostgreSQL-Port
POSTGRES_PORT: 5432
Runner-Job konfigurieren
Das Beispiel verwendet den ubuntu-latest GitHub-gehosteten Läufer als Docker-Host.
Der Workflow konfiguriert einen Servicecontainer mit der Kennzeichnung postgres. Alle Dienste müssen in einem Container ausgeführt werden, daher erfordert jeder Dienst, dass Du den Container image angibst. Dieses Beispiel verwendet das postgres Containerbild, stellt das standardmäßige PostgreSQL-Passwort bereit und enthält Optionen für Systemdiagnosen, um sicherzustellen, dass der Dienst ausgeführt wird. Weitere Informationen findest Du im postgres image auf „Docker Hub".
Der Workflow ordnet Port 5432 des PostgreSQL-Service-Containers dem Docker-Host zu. Weitere Informationen über das Schlüsselwort ports findest Du unter "Informationen über Service-Container."
jobs:
# Label des Runner-Jobs
runner-job:
# Du musst fuer Service-Containers oder Container-Jobs eine Linux-Umgebung verwenden
runs-on: ubuntu-latest
# Service-Containers zum Betrieb mit `runner-job`
services:
# Label fier den Zugriff auf den Service-Container
postgres:
# Docker-Hub-Image
image: postgres
# Das Passwort fuer Postgres bereitstellen
env:
POSTGRES_PASSWORD: postgres
# Health-Checks einstellen, dass sie warten, bis Postgres gestarted ist
options: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
ports:
# Ordnet TCP-Port 5432 des Service-Containers dem Host zu
- 5432:5432
„Steps“ (Schritte) konfigurieren
Der Workflow führt die folgenden Schritte aus:
- Auschecken des Repository auf dem Läufer
- Installieren von Abhängigkeiten
- Ausführen eines Script, um einen Client zu erstellen
steps:
# Laedt eine Kopie des Codes in Dein Repository herunter, bevor CI-Tests starten
- name: Check out repository code
uses: actions/checkout@v2
# Fuehrt eine saubere Installation aller Anhängigkeiten in der Datei `package.json` durch
# Weitere Informationen findest Du unter https://docs.npmjs.com/cli/ci.html
- name: Install dependencies
run: npm ci
- name: Connect to PostgreSQL
# Startet ein Skript, das einen PostgreSQL-Client erzeugt,
# den Client mit Daten befuellt und Daten abruft
run: node client.js
# Environment variable used by the `client.js` script to create
# a new PostgreSQL client.
env:
# Der Hostname zur Kommunikation with the PostgreSQL-Service-Container
POSTGRES_HOST: localhost
# Der standardmaessige PostgreSQL-Port
POSTGRES_PORT: 5432
Das Client.js-Skript sucht nach den POSTGRES_HOST und POSTGRES_PORT Umgebungsvariablen, um den Client zu erstellen. Der Workflow legt diese beiden Umgebungsvariablen als Teil des Schritts "Mit PostgreSQL verbinden" fest, um sie dem client.js-Skript zur Verfügung zu stellen. Weitere Informationen zum Skript findest Du unter "Testen des PostgreSQL-Dienstcontainers."
Der Hostname ist localhost oder 127.0.0.1.
Den PostgreSQL-Service-Container testen
Du kannst Deinen Workflow mit dem folgenden Skript testen, das einen PostgreSQL-Client erstellt und eine neue Tabelle mit Platzhalter-Daten hinzufügt. Das Skript gibt dann die im PostgreSQL-Client gespeicherten Werte auf dem Terminal aus. Dein Skript kann jede beliebige Sprache verwenden, aber in diesem Beispiel wird Node.js mit dem npm-Modul pg genutzt. Weitere Informationen findest Du unter npm-Modul pg.
Du kannst client.js anpassen, um alle PostgreSQL-Vorgänge einzuschließen, die für Deinen Workflow erforderlich sind. In diesem Beispiel erstellt das Skript die Instanz des PostgreSQL-Clients, erstellt eine Tabelle, fügt Platzhalter-Daten hinzu und ruft dann die Daten ab.
Füge Deinem Repository eine neue Datei namens client.js hinzu mit dem folgenden Code.
const { Client } = require('pg');
const pgclient = new Client({
host: process.env.POSTGRES_HOST,
port: process.env.POSTGRES_PORT,
user: 'postgres',
password: 'postgres',
database: 'postgres'
});
pgclient.connect();
const table = 'CREATE TABLE student(id SERIAL PRIMARY KEY, firstName VARCHAR(40) NOT NULL, lastName VARCHAR(40) NOT NULL, age INT, address VARCHAR(80), email VARCHAR(40))'
const text = 'INSERT INTO student(firstname, lastname, age, address, email) VALUES($1, $2, $3, $4, $5) RETURNING *'
const values = ['Mona the', 'Octocat', 9, '88 Colin P Kelly Jr St, San Francisco, CA 94107, United States', 'octocat@github.com']
pgclient.query(table, (err, res) => {
if (err) throw err
});
pgclient.query(text, values, (err, res) => {
if (err) throw err
});
pgclient.query('SELECT * FROM student', (err, res) => {
if (err) throw err
console.log(err, res.rows) // Print the data in student table
pgclient.end()
});
Das Skript erstellt einen neuen PostgreSQL-Client, der einen host- und einen port-Parameter akzeptiert. Das Skript verwendet die Umgebungsvariablen POSTGRES_HOST und POSTGRES_PORT, um die IP-Adresse und den Port des Clients festzulegen. Wenn host Und port nicht definiert sind, ist der Standard-Host localhost und der Standard-Port 5432.
Das Skript erstellt eine Tabelle und füllt sie mit Platzhalterdaten auf. Um zu testen, ob die PostgreSQL-Datenbank die Daten enthält, gibt das Skript den Inhalt der Tabelle in das Konsolenprotokoll aus.
Wenn Du diesen Workflow ausführst, solltest Du im Schritt „Mit PostgreSQL verbinden“ die folgende Ausgabe sehen, welche zeigt, dass Du den PostgreSQL-Client erstellt und Daten hinzugefügt hast:
null [ { id: 1,
firstname: 'Mona the',
lastname: 'Octocat',
age: 9,
address:
'88 Colin P Kelly Jr St, San Francisco, CA 94107, United States',
email: 'octocat@github.com' } ]
