This is an automated email from the ASF dual-hosted git repository.
jbonofre pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/karaf.git
The following commit(s) were added to refs/heads/main by this push:
new f182d8ba6e Clarify what's included in kar files (#2257)
f182d8ba6e is described below
commit f182d8ba6eba60262cd1759d678d9358f496f3b9
Author: JB Onofré <[email protected]>
AuthorDate: Wed Feb 4 10:55:55 2026 +0100
Clarify what's included in kar files (#2257)
---
manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc | 4 ++--
manual/src/main/asciidoc/user-guide/kar.adoc | 8 +++++---
2 files changed, 7 insertions(+), 5 deletions(-)
diff --git a/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
b/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
index de3477ced1..47090ee60a 100644
--- a/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
+++ b/manual/src/main/asciidoc/developer-guide/karaf-maven-plugin.adoc
@@ -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`.
diff --git a/manual/src/main/asciidoc/user-guide/kar.adoc
b/manual/src/main/asciidoc/user-guide/kar.adoc
index 322006bfa1..e2418cfc77 100644
--- a/manual/src/main/asciidoc/user-guide/kar.adoc
+++ b/manual/src/main/asciidoc/user-guide/kar.adoc
@@ -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 be
included in a Karaf distribution (script files, configuration files, ...)
NB: as kar is a zip file, it doesn't require a `META-INF/MANIFEST.MF` file.
However, as the `karaf-maven-plugin` plugin uses Jar archive to create kar, it
includes a `META-INF/MANIFEST.MF` (even if useless).
