Document application packaging and deployment (single JAR, Docker, systemd, PSGI)
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Aptitud para principiantes
- 58/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Área
- documentation
Línea de trabajo
Start by reading docs/getting-started/docker.md, examples/http_server_plack/README.md, the shadow-JAR configuration in build.gradle, and the PerlIncHandler/RuntimeScalar.java code that defines @INC. Draft docs/guides/deployment.md scenario by scenario, running the documented commands and the Docker build as you go. Link the guide from README.md and docs/README.md, then run make check-links; done means every scenario has a tested example and the Dockerfile builds and runs.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Problem
PerlOnJava bundles 150+ modules in a single JAR and runs on Linux, macOS, and
Windows, but there is no documentation explaining how a user packages their own
Perl application for deployment. The gap between "it works after make" and
"I can ship this to a server" is undocumented.
Today a user who wants to deploy must reverse-engineer the JAR layout, figure
out how @INC resolves resources inside the JAR, and guess at the right
Dockerfile layers. This is the single largest barrier to the "single JAR"
value proposition and comes up immediately when presenting the project to new
users.
Requested deliverable
A new guide at docs/guides/deployment.md (linked from the README and the
docs index) covering the scenarios below. Each scenario should include a
complete, copy-pasteable example that a user can adapt.
1. Running a script from the filesystem
The simplest case: jperl points at a script and a lib/ directory on disk.
Document the directory layout, how to pass -Ilib, and how @INC search
order works (bundled modules, then filesystem paths, then JPERL_LIB if any).
2. Adding application code to the JAR
How to add .pl and .pm files to the shadow JAR so the result is a single
self-contained artifact. Cover:
- Where in the JAR tree application modules should go (the resource path that
maps to@INC). - A Gradle task or shell recipe that takes a source directory and produces an
augmented JAR. - How to set the entry-point script so
java -jar app.jarruns the
application directly. - Whether and how
jcpan-installed modules can be baked in.
3. Docker deployment
Extend the existing docs/getting-started/docker.md (or link to it) with a
production-oriented multi-stage Dockerfile that:
- Builds the augmented JAR in a builder stage.
- Copies only the JAR and a JRE into the final image.
- Sets
ENTRYPOINTso the container runs the application. - Shows how to add JDBC drivers.
The existing Docker page covers building PerlOnJava itself; this section
covers deploying an application on top of it.
4. systemd / process manager
A minimal example of running the JAR as a long-lived service: a systemd unit
file, or equivalent guidance for other process managers. Cover JVM memory
flags, restart policy, and log output.
5. PSGI / web application deployment
A worked example combining Plack::Handler::Netty with the JAR packaging from
scenario 2, producing a single JAR that starts an HTTP server. Link to the
existing examples/http_server_plack/ for the application code; this section
covers only the packaging and deployment side.
Acceptance criteria
docs/guides/deployment.mdexists and is linked fromREADME.mdand
docs/README.md.- Each scenario has a complete, tested example (commands and expected output).
make check-linkspasses.- The Dockerfile example builds and runs successfully.
Non-goals
- Changing the JAR layout or
@INCresolution (document what exists today). - Windows-specific deployment (a follow-up can add
.batand Windows Service
examples). - GraalVM native-image packaging (tracked separately in
dev/design/graalvm.md).
Context
- Existing Docker docs:
docs/getting-started/docker.md - Existing PSGI example:
examples/http_server_plack/README.md - JAR resource layout: controlled by
build.gradleshadow plugin configuration @INCresolution:src/main/java/org/perlonjava/runtime/RuntimeScalar.java
and thePerlIncHandlerclass- Related design doc:
dev/design/distro.md
- Lenguaje dominante
- Perl
- Estrellas
- 67
- Forks
- 8
- Merge medio
- 5 h 12 min
- PR fusionados (30 d)
- 131
Preparar el entorno
- Incluye un Dockerfile o un archivo de Docker Compose
- Sin plantilla de pull request
- Leer la guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de fglock/PerlOnJava
-
area:cpan-port bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
fglock/PerlOnJava#2153 ·
Los mantenedores suelen responder en 1 día
-
area:cpan-port area:parser bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
fglock/PerlOnJava#2137 ·
Los mantenedores suelen responder en 1 día
-
area:backend area:cpan-port area:runtime bug
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
fglock/PerlOnJava#2071 ·
Los mantenedores suelen responder en 1 día
-
area:runtime documentation enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
fglock/PerlOnJava#1579 ·
Los mantenedores suelen responder en 1 día
-
area:cpan-port bug
Dificultad 3/5 1-2 días Aptitud para principiantes 62/100
fglock/PerlOnJava#2157 ·
Los mantenedores suelen responder en 1 día
Todos los issues de fglock/PerlOnJava
Issues similares
-
Dev-output directory preparation accepts file-valued lib/include paths and fails on dangling linksAbiertoteam-cli
Dificultad 2/5 1-3 horas Aptitud para principiantes 70/100
Los mantenedores suelen responder en 2 días
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 66/100
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 93/100
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 73/100
inverse-inc/packetfence#9728 ·
Los mantenedores suelen responder en 1 día
-
fix(char-create): show the real reason a character is refusedPosiblemente ocupada @baphomello la tomó hace 1 día. Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Los mantenedores suelen responder en 1 día