Skip to content

Clarify what's included in kar files #2257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jbonofre wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −5
Open

Clarify what's included in kar files #2257

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -395,9 +395,9 @@ with the `karaf:features-generate-descriptor` goal.

There are two important directories in a kar:

* `repository/` contains a Maven structured repository of artifacts to be copied into the Karaf repository.
* `repository/` contains a Maven structured repository of artifacts to be copied into the Karaf repository.
The features descriptor and all the bundles mentioned in it are installed in this directory.
* `resources/` contains other resources to be copied over the Karaf installation.
* optionally, `resources/` contains other resources to be copied over the Karaf distribution (shell scripts, configuration files, ...).

Everything in `target/classes` is copied into the kar.
Therefore resources you want installed into Karaf need to be in e.g. `src/main/resources/resources`.
Expand Down
8 changes: 5 additions & 3 deletions manual/src/main/asciidoc/user-guide/kar.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,12 @@ of this XML. This artifact is named a KAR (KAraf aRchive).

A KAR file is essentially a jar (so a zip file) which contains a set of feature descriptor and bundle jar files.

A KAR file contains a `repository` folder containing:
A KAR file contains:

* a set of features XML files
* the artifacts following the Maven directory structure (`groupId/artifactId/version/artifactId-version.type`).
* a `repository` folder containing:
** a set of features repositories XML or JSON files
** the artifacts (jar files) following the Maven directory structure (`groupId/artifactId/version/artifactId-version.type`).
* optionally a `resources` folder containing all resources that could included in a Karaf distribution (script files, configuration files, ...)

For instance, the `spring-4.0.0.kar` contains:

Expand Down
Loading