Document application packaging and deployment (single JAR, Docker, systemd, PSGI)

Open
#2,142 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
58/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
docker, dockerfile, java, markdown, perl, shell
Domain
documentation

Research direction

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.

Written by the indexing model from the issue text.

Description

documentation enhancement help wanted

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.jar runs 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 ENTRYPOINT so 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.md exists and is linked from README.md and
    docs/README.md.
  • Each scenario has a complete, tested example (commands and expected output).
  • make check-links passes.
  • The Dockerfile example builds and runs successfully.

Non-goals

  • Changing the JAR layout or @INC resolution (document what exists today).
  • Windows-specific deployment (a follow-up can add .bat and 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.gradle shadow plugin configuration
  • @INC resolution: src/main/java/org/perlonjava/runtime/RuntimeScalar.java
    and the PerlIncHandler class
  • Related design doc: dev/design/distro.md
Dominant language
Perl
Stars
67
Forks
8
Avg merge
5h 12m
Merged PRs (30d)
131

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from fglock/PerlOnJava

All issues in fglock/PerlOnJava

Similar issues

More Perl issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.