Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
 darroyo
|
bc5ffaf1d2 | ||
|
darroyo
|
bd196ec9e0 |
@@ -0,0 +1,198 @@
|
||||
# Scripts de despliegue
|
||||
|
||||
Guía de uso de los scripts de este directorio.
|
||||
|
||||
## `build-and-push.sh`
|
||||
|
||||
Construye la imagen nativa de Quarkus y la envía al daemon Docker de un host remoto por SSH, sin usar un registry externo ([unregistry](https://github.com/psviderski/unregistry) / `docker pussh`). Solo se transfieren las capas que el remoto aún no tiene.
|
||||
|
||||
### Qué hace el flujo
|
||||
|
||||
1. Lee `artifactId` y `version` de [`pom.xml`](../pom.xml) para formar la referencia de imagen (`nombre:tag`), salvo que uses `--name` o `--tag`.
|
||||
2. Ejecuta `docker build` con [`src/main/docker/Dockerfile`](../src/main/docker/Dockerfile) para la plataforma fija `linux/amd64` (útil si construyes desde un Mac arm64).
|
||||
3. Ejecuta `docker pussh` hacia el destino SSH indicado.
|
||||
4. Comprueba por SSH que la imagen existe en el remoto (salvo `--no-verify`).
|
||||
5. Muestra un comando `docker run` sugerido para arrancar el contenedor en el remoto.
|
||||
|
||||
### Requisitos
|
||||
|
||||
| Requisito | Descripción |
|
||||
|-----------|-------------|
|
||||
| Docker local | Daemon en marcha (`docker info` debe responder). |
|
||||
| SSH | Acceso al host remoto; en el remoto debe estar instalado y usable Docker. |
|
||||
| Plugin `docker pussh` | CLI plugin de unregistry. |
|
||||
|
||||
Si el plugin no está instalado, el script indica cómo añadirlo:
|
||||
|
||||
```shell
|
||||
mkdir -p ~/.docker/cli-plugins
|
||||
curl -fsSL https://raw.githubusercontent.com/psviderski/unregistry/main/docker-pussh \
|
||||
-o ~/.docker/cli-plugins/docker-pussh
|
||||
chmod +x ~/.docker/cli-plugins/docker-pussh
|
||||
```
|
||||
|
||||
`xmllint` es opcional: si no está en el PATH, el script obtiene `artifactId` y `version` del POM con `grep`/`sed`.
|
||||
|
||||
### Invocación
|
||||
|
||||
Puedes ejecutar el script desde cualquier directorio. Por defecto usa como raíz del proyecto el directorio padre de `scripts/` (donde está `pom.xml`).
|
||||
|
||||
```shell
|
||||
./scripts/build-and-push.sh --remote USER@HOST
|
||||
```
|
||||
|
||||
Alternativas para la raíz del proyecto:
|
||||
|
||||
- `--project-dir /ruta/al/proyecto`
|
||||
- variable de entorno `PROJECT_DIR`
|
||||
|
||||
Ayuda integrada (en inglés):
|
||||
|
||||
```shell
|
||||
./scripts/build-and-push.sh --help
|
||||
```
|
||||
|
||||
### Opciones
|
||||
|
||||
**Destino (obligatorio)**
|
||||
|
||||
| Opción | Descripción |
|
||||
|--------|-------------|
|
||||
| `--remote TARGET` | Destino SSH: `usuario@host[:puerto]` o un alias definido en `~/.ssh/config` (sin `@`). |
|
||||
|
||||
**Identidad de la imagen** (por defecto desde `pom.xml`)
|
||||
|
||||
| Opción | Descripción |
|
||||
|--------|-------------|
|
||||
| `--name NAME` | Nombre del repositorio de la imagen. |
|
||||
| `--tag TAG` | Tag de la imagen. |
|
||||
|
||||
**Directorio de trabajo**
|
||||
|
||||
| Opción | Descripción |
|
||||
|--------|-------------|
|
||||
| `--project-dir PATH` | Raíz del proyecto (debe contener `pom.xml`). |
|
||||
| `PROJECT_DIR` | Misma función vía entorno. |
|
||||
|
||||
**Build**
|
||||
|
||||
| Opción | Descripción |
|
||||
|--------|-------------|
|
||||
| `--skip-build` | No construye; solo hace `pussh` de una imagen que ya exista en local. La plataforma de build sigue siendo `linux/amd64` cuando no se omite el build. |
|
||||
|
||||
**SSH** (se reenvían a `docker pussh` y, en la verificación, a `ssh`)
|
||||
|
||||
| Opción | Descripción |
|
||||
|--------|-------------|
|
||||
| `--ssh-key PATH` | Clave privada; tiene prioridad sobre `IdentityFile` del config SSH. |
|
||||
| `--ssh-config PATH` | Archivo de configuración SSH (por defecto `~/.ssh/config`). |
|
||||
|
||||
**Post-push**
|
||||
|
||||
| Opción | Descripción |
|
||||
|--------|-------------|
|
||||
| `--no-verify` | Omite la comprobación `docker images` en el remoto. |
|
||||
|
||||
**Otros**
|
||||
|
||||
| Opción | Descripción |
|
||||
|--------|-------------|
|
||||
| `-h`, `--help` | Muestra la ayuda del script. |
|
||||
|
||||
### Alias en `~/.ssh/config`
|
||||
|
||||
Si `--remote` es un alias sin `@`, el script resuelve `HostName`, `User`, `Port` e `IdentityFile` del bloque `Host` correspondiente. `--ssh-key` siempre anula `IdentityFile`.
|
||||
|
||||
Ejemplo de configuración:
|
||||
|
||||
```text
|
||||
# ~/.ssh/config
|
||||
Host prod
|
||||
HostName prod.example.com
|
||||
User deploy
|
||||
Port 22
|
||||
IdentityFile ~/.ssh/deploy_ed25519
|
||||
```
|
||||
|
||||
Uso:
|
||||
|
||||
```shell
|
||||
./scripts/build-and-push.sh --remote prod
|
||||
# Equivale a deploy@prod.example.com:22 con la clave del bloque Host prod
|
||||
```
|
||||
|
||||
### Ejemplos
|
||||
|
||||
Destino explícito:
|
||||
|
||||
```shell
|
||||
./scripts/build-and-push.sh --remote deploy@prod.example.com
|
||||
```
|
||||
|
||||
Alias SSH:
|
||||
|
||||
```shell
|
||||
./scripts/build-and-push.sh --remote prod
|
||||
```
|
||||
|
||||
Clave explícita:
|
||||
|
||||
```shell
|
||||
./scripts/build-and-push.sh --remote ubuntu@1.2.3.4 --ssh-key ~/.ssh/deploy_ed25519
|
||||
```
|
||||
|
||||
Solo push (imagen ya construida) con otro tag:
|
||||
|
||||
```shell
|
||||
./scripts/build-and-push.sh --remote deploy@prod --skip-build --tag 2.0.0
|
||||
```
|
||||
|
||||
Ruta absoluta al script:
|
||||
|
||||
```shell
|
||||
/absolute/path/to/test-quarkus/scripts/build-and-push.sh --remote deploy@prod
|
||||
```
|
||||
|
||||
Proyecto en otra ruta:
|
||||
|
||||
```shell
|
||||
PROJECT_DIR=/srv/proj ./scripts/build-and-push.sh --remote deploy@prod --skip-build
|
||||
```
|
||||
|
||||
### Después del push
|
||||
|
||||
Al terminar con éxito, el script sugiere algo equivalente a:
|
||||
|
||||
```shell
|
||||
ssh deploy@prod.example.com \
|
||||
"docker run -d --name <artifactId> --restart unless-stopped -p 8080:8080 <artifactId>:<version>"
|
||||
```
|
||||
|
||||
Sustituye `<artifactId>` y `<version>` por los valores que haya usado el build (los del POM o los de `--name` / `--tag`).
|
||||
|
||||
### Solución de problemas
|
||||
|
||||
#### `invalid reference format` con saltos de línea en el tag
|
||||
|
||||
Si `docker build` falla con un tag parecido a `test-quarkus\n1.0.0-SNAPSHOT:test-quarkus\n1.0.0-SNAPSHOT`, el checkout del script es anterior al commit `57af30f`. En hosts sin `xmllint` (por ejemplo vm-compilador), el fallback antiguo de `read_pom` mezclaba `artifactId` y `version` en una sola cadena.
|
||||
|
||||
En la máquina donde compilas (`~/repo` u otra ruta del proyecto):
|
||||
|
||||
```shell
|
||||
git rev-parse --short HEAD
|
||||
grep -n 'head -2' scripts/build-and-push.sh || echo "script actualizado"
|
||||
git pull
|
||||
git rev-parse --short HEAD # debe ser 57af30f o posterior
|
||||
./scripts/build-and-push.sh --remote TU_DESTINO
|
||||
```
|
||||
|
||||
Comprueba que la primera línea del log sea `Image: test-quarkus:1.0.0-SNAPSHOT` (sin saltos de línea).
|
||||
|
||||
**Atajo** si aún no puedes actualizar el repo: fija nombre y tag explícitos (no usa el fallback roto):
|
||||
|
||||
```shell
|
||||
./scripts/build-and-push.sh --remote TU_DESTINO \
|
||||
--name test-quarkus --tag 1.0.0-SNAPSHOT
|
||||
```
|
||||
|
||||
Opcional: instala `xmllint` para que el script lea el POM con XPath (`libxml2-utils` en Debian/Ubuntu).
|
||||
@@ -1,5 +1,5 @@
|
||||
## Stage 1 : build with maven builder image with native capabilities
|
||||
FROM quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-21 AS build
|
||||
FROM quay.io/quarkus/ubi-quarkus-mandrel-builder-image:jdk-25 AS build
|
||||
COPY --chown=quarkus:quarkus mvnw /code/mvnw
|
||||
COPY --chown=quarkus:quarkus .mvn /code/.mvn
|
||||
COPY --chown=quarkus:quarkus pom.xml /code/
|
||||
|
||||
Reference in New Issue
Block a user