Nota: Los ejecutores hospedados en GitHub no son compatibles con GitHub Enterprise Server actualmente. Puedes encontrar más información sobre el soporte que se tiene planeado en el futuro en el Itinerario público de GitHub.
Introducción
En esta guía se muestran ejemplos de flujos de trabajo que configuran un contenedor de servicios mediante la imagen postgres
de Docker Hub. El flujo de trabajo ejecuta un script que se conecta con el servicio de PostgreSQL, crea una tabla y luego la llena de datos. Para probar que el flujo de trabajo crea y puebla la tabla de PostgreSQL, el script imprimie los datos de esta en la consola.
Nota: Si tus flujos de trabajo utilizan acciones de contenedor de Docker, contenedores de jobs o de servicio, entonces debes utilizar un ejecutor Linux:
- Si estás utilizando ejecutores hospedados en GitHub, debes utilizar un ejecutor de Ubuntu.
- Si estás utilizando ejecutores auto-hospedados, debes utilizar una máquina Linux como tu ejecutor, y ésta debe tener Docker instalado.
Prerrequisitos
Debes familiarizarte con la forma en la que trabajan los contenedores de servicio con GitHub Actions y las diferencias de conexión de red entre los jobs que se están ejecutando directamente en el ejecutor y las que lo hacen en un contenedor. Para obtener más información, consulta la sección "Acerca de los contenedores de servicios".
También puede ser útil tener un conocimiento básico de YAML, la sintaxis para las GitHub Actions, y de PostgreSQL. Para obtener más información, consulta:
- "Aprende sobre las GitHub Actions"
- "Tutorial de PostgreSQL" en la documentación de PostgreSQL
Ejecutar trabajos en contenedores
La configuración de jobs para su ejecución en un contenedor simplifica las configuraciones de red entre el job y los contenedores de servicio. Los contenedores de Docker en el mismo puente de red definido por el usuario exponen todos los puertos entre ellos, así que no necesitas mapear ninguno de los puertos para contenedores de servicio en el alojamiento de Docker. Puedes acceder al contenedor de servicio desde el contenedor del job utilizando la etiqueta que configuras en el flujo de trabajo.
Puedes copiar este archivo de flujo de trabajo al directorio .github/workflows
de tu repositorio y modificarlo como lo requieras.
name: PostgreSQL service 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
postgres:
# Docker Hub image
image: postgres
# Provide the password for postgres
env:
POSTGRES_PASSWORD: postgres
# Set health checks to wait until postgres has started
options: >-
--health-cmd pg_isready
--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 PostgreSQL
# Runs a script that creates a PostgreSQL table, populates
# the table with data, and then retrieves the data.
run: node client.js
# Environment variables used by the `client.js` script to create a new PostgreSQL table.
env:
# Nombre del host utilizado para comunicarse con el contenedor de servicios PostgreSQL
POSTGRES_HOST: Postgres
# Puerto PostgreSQL predeterminado
POSTGRES_PORT: 5432
Configurar el trabajo del ejecutador
Este flujo de trabajo configura un job que se ejecuta en el contenedor node:10.18-jessie
y utiiza el ejecutor ubuntu-latest
hospedado en GitHub como el alojamiento de Docker para el contenedor. Para obtener más información acerca del contenedor node:10.18-jessie
, consulta la imagen del nodo en Docker Hub.
El flujo de trabajo configura un contenedor de servicio con la etiqueta postgres
. Todos los servicios se deben ejecutar en un contenedor, entonces cada servicio requiere que especifiques la image
del mismo. Este ejemplo utiliza la imagen del contenedor postgres
, proporciona la cotraseña predeterminada de PostgreSQL, e incluye las opciones de revisión de estado para garantizar que el servicio se está ejecutando. Para obtener más información, consulta la imagen de postgre en Docker Hub.
jobs:
# Etiqueta del trabajo del contenedor
container-job:
# Los contenedores deben ejecutarse en sistemas operativos basados en Linux
runs-on: ubuntu-latest
# Imagen de Docker Hub que `container-job` ejecuta en el contenedor: node:10.18-jessie
# Contenedores de servicios para ejecutar con servicios de `container-job`:
# Etiqueta utilizada para acceder al contenedor de servicios
redis:
# Imagen de Docker Hub
image: redis
# Establece revisiones de estado para esperar hasta que Redis inicie las
opciones: >-
--health-cmd "redis-cli ping"
--health-interval 10s
--health-timeout 5s
--health-retries 5
Configurar los pasos
El flujo de trabajo realiza los siguientes pasos:
- Verifica el repositorio en el ejecutor
- Instala las dependencias
- Ejecuta un script para crear un cliente
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 PostgreSQL
# Runs a script that creates a PostgreSQL table, populates
# the table with data, and then retrieves the data.
run: node client.js
# Environment variable used by the `client.js` script to create
# a new PostgreSQL client.
env:
# Nombre del host utilizado para comunicarse con el contenedor de servicios PostgreSQL
POSTGRES_HOST: Postgres
# Puerto PostgreSQL predeterminado
POSTGRES_PORT: 5432
El script client.js busca las variables del ambiente de POSTGRES_HOST
y POSTGRES_PORT
para crear al cliente. El flujo de trabajo configura estas dos variables de ambiente como parte del paso "Conectar a PostgreSQL" para hacerlos disponibles para el script client.js. Para obtener más información acerca del script, consulta "Probar el contenedor de servicio de PostgreSQL".
El nombre del host del servicio PostgreSQL es la etiqueta que configuraste en tu flujo de trabajo, en este caso, postgres
. Dado que los contenedores de Docker de la misma red de puentes definida por el usuario abren todos los puertos por defecto, podrás acceder al contenedor de servicios en el puerto 5432 PostgreSQL predeterminado.
Ejecutar trabajos directamente en la máquina del ejecutor
Cuando ejecutes un trabajo directamente en la máquina del ejecutor, deberás asignar los puertos del contenedor de servicios a los puertos del host de Docker. Puedes acceder a los contenedores de servicios desde el host de Docker utilizando localhost
y el número de puerto del host de Docker.
Puedes copiar este archivo de flujo de trabajo al directorio .github/workflows
de tu repositorio y modificarlo como lo requieras.
name: PostgreSQL Service 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
postgres:
# Docker Hub image
image: postgres
# Provide the password for postgres
env:
POSTGRES_PASSWORD: postgres
# Set health checks to wait until postgres has started
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:
# 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 PostgreSQL
# Runs a script that creates a PostgreSQL table, populates
# the table with data, and then retrieves the data
run: node client.js
# Environment variables used by the `client.js` script to create
# a new PostgreSQL table.
env:
# Nombre del host utilizado para comunicarse con el contenedor de servicios PostgreSQL
POSTGRES_HOST: localhost
# Puerto PostgreSQL predeterminado
POSTGRES_PORT: 5432
Configurar el trabajo del ejecutador
El ejemplo utiliza el ejecutor ubuntu-latest
hospedado en GitHub como el hospedaje de Docker.
El flujo de trabajo configura un contenedor de servicio con la etiqueta postgres
. Todos los servicios se deben ejecutar en un contenedor, entonces cada servicio requiere que especifiques la image
del mismo. Este ejemplo utiliza la imagen del contenedor postgres
, proporciona la cotraseña predeterminada de PostgreSQL, e incluye las opciones de revisión de estado para garantizar que el servicio se está ejecutando. Para obtener más información, consulta la imagen de postgre en Docker Hub.
El flujo de trabajo asigna el puerto 5432 del contenedor de servicios PostgreSQL al host de Docker. Para obtener más información acerca de la palabra clave ports
, consulta "Acerca de los contenedores de servicio".
jobs:
# Etiqueta del trabajo del ejecutador
Runner-Job:
# Debes usar un entorno Linux cuando uses contenedores de servicios o trabajos del contenedor
runs-on: ubuntu-latest
# Contenedores de servicios para ejecutar con servicios 'runner-job':
# Etiqueta usada para acceder al contenedor de servicios
Postgres:
# Imagen de Docker Hub
image: postgres
# Proporciona la contraseña para postgres
Env:
POSTGRES_PASSWORD: postgres
# Establece chequeos de estado para esperar hasta que postgres inicie las
opciones: >-
--health-cmd pg_isready
--health-interval 10s
--health-timeout 5s
--health-retries 5
Ports:
# Asigna el puerto tcp 5432 del contenedor de servicios al host
-5432:5432
Configurar los pasos
El flujo de trabajo realiza los siguientes pasos:
- Verifica el repositorio en el ejecutor
- Instala las dependencias
- Ejecuta un script para crear un cliente
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 PostgreSQL
# Runs a script that creates a PostgreSQL table, populates
# the table with data, and then retrieves the data
run: node client.js
# Environment variables used by the `client.js` script to create
# a new PostgreSQL table.
env:
# Nombre del host utilizado para comunicarse con el contenedor de servicios PostgreSQL
POSTGRES_HOST: localhost
# Puerto PostgreSQL predeterminado
POSTGRES_PORT: 5432
El script client.js busca las variables del ambiente de POSTGRES_HOST
y POSTGRES_PORT
para crear al cliente. El flujo de trabajo configura estas dos variables de ambiente como parte del paso "Conectar a PostgreSQL" para hacerlos disponibles para el script client.js. Para obtener más información acerca del script, consulta "Probar el contenedor de servicio de PostgreSQL".
El nombre del hospedaje es localhost
o 127.0.0.1
.
Probar el contenedor de servicios de PostgreSQL
Puedes probar tu flujo de trabajo utilizando el siguiente script, el cual se conecta con el servicio de PostgreSQL y agrega una tabla nueva con algunos datos de marcador de posición. Entonces, el script imprime los valores almacenados en la tabla de PostgreSQL en la terminal. Tu script puede usar el lenguaje que quieras, pero este ejemplo usa Node.js y el módulo npm de pg
. Para obtener más información, consulta el módulo npm de pg.
Puedes modificar client.js para incluir cualquier operación de PostgreSQL que necesite tu flujo de trabajo. En este ejemplo, el script se conecta al servicio de PostgreSQL, agrega la tabla a la base de datos de postgres
, inserta algunos datos de marcador de posición y luego recupera los datos.
Agrega a tu repositorio un archivo nuevo llamado client.js con el siguiente código.
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()
});
El script crea una conexión nueva con el servicio de PostgreSQL y utiliza las variables de ambiente POSTGRES_HOST
y POSTGRES_PORT
para especificar el puerto y dirección IP del servicio de PostgreSQL. Si host
y port
no están definidos, el host predeterminado es localhost
y el puerto predeterminado es 5432.
El script crea una tabla y la rellena con datos de marcador de posición. Para probar que la base de datos de postgres
contenga los datos, el script imprime el contenido de la tabla en la bitácora de la consola.
Cuando ejecutas este flujo de trabajo, debes ver la siguiente salida en el paso de "Connect to PostgreSQL", la cual te confirma que creaste exitosamente la tabla de PostgreSQL y agregaste los datos:
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' } ]