I tried to fix the pages I modified.... thanks david jencks
On Nov 27, 2011, at 2:55 AM, Glen Mazza wrote: > David (and everyone else), you should be using "Maven" and "Karaf" instead of > "maven" and "karaf". > > Glen > > On 11/26/2011 03:33 PM, djen...@apache.org wrote: >> Author: djencks >> Date: Sat Nov 26 20:33:44 2011 >> New Revision: 1206581 >> >> URL: http://svn.apache.org/viewvc?rev=1206581&view=rev >> Log: >> KARAF-424 update documentation for kar and karaf-assembly packaging >> >> Modified: >> >> karaf/trunk/manual/src/main/webapp/developers-guide/custom-distribution.conf >> >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf >> >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-create-kar.conf >> >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-instance-create-archive.conf >> >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin.conf >> >> Modified: >> karaf/trunk/manual/src/main/webapp/developers-guide/custom-distribution.conf >> URL: >> http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/developers-guide/custom-distribution.conf?rev=1206581&r1=1206580&r2=1206581&view=diff >> ============================================================================== >> --- >> karaf/trunk/manual/src/main/webapp/developers-guide/custom-distribution.conf >> (original) >> +++ >> karaf/trunk/manual/src/main/webapp/developers-guide/custom-distribution.conf >> Sat Nov 26 20:33:44 2011 >> @@ -15,7 +15,7 @@ This custom distribution could contain: >> >> h2. Maven assembly >> >> -The recommended way to create a karaf server assembly is to use the >> karaf-assembly packaging with the karaf-maven-plugin. This assembles a >> server from the maven dependencies in the project pom. After explanation of >> the configuration options we present an example. This is used to assemble >> the official karaf distributions, but due to maven limitations we have to >> simulate rather than use the karaf-assembly packaging. >> +The recommended way to create a karaf server assembly is to use the >> karaf-assembly packaging with the karaf-maven-plugin. This assembles a >> server from the maven dependencies in the project pom. After explanation of >> the configuration options we present an example. The karaf project >> effectively uses this packaging to assemble the official karaf >> distributions, but due to maven limitations we have to simulate rather than >> use the karaf-assembly packaging. >> >> This packaging creates tar.gz and zip archives containing the assembled >> server. They are identical except that zip archives don't unpack with >> appropriate unix file permissions for the scripts. >> >> >> Modified: >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf >> URL: >> http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf?rev=1206581&r1=1206580&r2=1206581&view=diff >> ============================================================================== >> --- >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf >> (original) >> +++ >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-add-to-repository.conf >> Sat Nov 26 20:33:44 2011 >> @@ -1,5 +1,7 @@ >> h2. Goal {{karaf:features-add-to-repository}} >> >> +Consider using the karaf-assembly packaging which makes it easy to assemble >> a custom distribution in one step instead of this individual goal. >> + >> The {{karaf:features-add-to-repository}} goal adds all the required bundles >> for a given set of features into directory. You can use this goal to create >> a {{/system}} directory for building your own Karaf-based distribution. >> >> By default, the Karaf core features descriptors (standard and enterprise) >> are automatically included in the descriptors set. >> >> Modified: >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-create-kar.conf >> URL: >> http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-create-kar.conf?rev=1206581&r1=1206580&r2=1206581&view=diff >> ============================================================================== >> --- >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-create-kar.conf >> (original) >> +++ >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-features-create-kar.conf >> Sat Nov 26 20:33:44 2011 >> @@ -1,51 +1,33 @@ >> h2. Goal {{karaf:features-create-kar}} >> >> -The {{karaf:features-create-kar}} goal assembles a KAR archive from a >> features XML descriptor file. >> +Except in unusual circumstances, use the<packaging>kar</packaging> to run >> this goal. >> + >> +The {{karaf:features-create-kar}} goal assembles a KAR archive from a >> features XML descriptor file, normally generated in the same project with >> the {{karaf:features-generate-descriptor}} mojo. >> + >> +h2. kar layout >> + >> +There are two important directories in a kar: >> +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. >> + >> +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. This choice is so other resources such as >> legal files from the maven-remote-resources-plugin can be included under >> META-INF in the kar, without getting installed into karaf. >> >> h3. Example >> -The example below validates the features defined in the >> {{target/features.xml}} by checking all the imports and exports. It reads >> the definition for the packages that are exported by the system bundle from >> the {{src/main/resources/config.properties}} file. >> {pygmentize:xml} >> <project> >> +... >> +<packaging>kar</packaging> >> <build> >> <plugins> >> <plugin> >> <groupId>org.apache.karaf.tooling</groupId> >> <artifactId>karaf-maven-plugin</artifactId> >> <version>${project.version}</version> >> -<executions> >> -<execution> >> -<id>create-kar</id> >> -<phase>package</phase> >> -<goals> >> -<goal>features-create-kar</goal> >> -</goals> >> -<configuration> >> -<outputDirectory>${project.build.directory}</outputDirectory> >> -<finalName>mykar</finalName> >> -<resourcesDir>${project.build.directory}/classes</resourcesDir> >> -<featuresFile>${project.build.directory}/feature/feature.xml</featuresFile> >> -<repositoryPath>repository/</repositoryPath> >> -</configuration> >> -</execution> >> -</executions> >> -<dependencies> >> -<dependency> >> -<groupId>org.slf4j</groupId> >> -<artifactId>slf4j-simple</artifactId> >> -<version>1.4.3</version> >> - </dependency> >> -</dependencies> >> -</plugin> >> +<extensions>true</extensions> >> +<!-- There is no useful configuration for the kar mojo. The >> features-generate-descriptor mojo configuration may be useful --> >> +</plugin> >> </plugins> >> </build> >> </project> >> {pygmentize} >> >> -h3. Parameters >> - >> -|| Name || Type || Description || >> -| {{outputDirectory}} | {{File}} | Directory containing the generated >> archive. \\ Default value: {{${project.build.directory}}} | >> -| {{finalName}} | {{String}} | Name of the generated archive. \\ Default >> value: {{${project.build.finalName}}} | >> -| {{resourcesDir}} | {{File}} | Location of resources directory for >> additional content to include in the kar. \\ Default value: >> {{${project.build.directory}/classes}} | >> -| {{featuresFile}} | {{File}} | The features file to use as instructions. >> \\ Default value: {{${project.build.directory}/feature/feature.xml}} | >> -| {{repositoryPath}} | {{String}} | The internal repository in the kar. \\ >> Default value: {{${repositoryPath}}} | >> \ No newline at end of file >> >> Modified: >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-instance-create-archive.conf >> URL: >> http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-instance-create-archive.conf?rev=1206581&r1=1206580&r2=1206581&view=diff >> ============================================================================== >> --- >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-instance-create-archive.conf >> (original) >> +++ >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin-instance-create-archive.conf >> Sat Nov 26 20:33:44 2011 >> @@ -1,5 +1,7 @@ >> h2. Goal {{karaf:instance-create-archive}} >> >> +Normally this is run as part of the karaf-assembly packaging. >> + >> The {{karaf:instance-create-archive}} goal packages a Karaf instance >> archive from a given assembled instance. >> >> Both tar.gz and zip formats are generated in the destination folder. >> @@ -36,6 +38,6 @@ The example below create archives for th >> >> h3. Parameters >> || Name || Type || Description || >> -| {{destDir}} | {{File}} | he target directory of the project. \\ Default >> value: ${project.build.directory} | >> +| {{destDir}} | {{File}} | The target directory of the project. \\ Default >> value: ${project.build.directory} | >> | {{targetServerDirectory}} | {{File}} | The location of the server >> repository. \\ Default value: ${project.build.directory}/assembly | >> | {{targetFile}} | {{File}} | The target file to set as the project's >> artifact. \\ Default value: ${project.file} | >> >> Modified: >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin.conf >> URL: >> http://svn.apache.org/viewvc/karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin.conf?rev=1206581&r1=1206580&r2=1206581&view=diff >> ============================================================================== >> --- >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin.conf >> (original) >> +++ >> karaf/trunk/manual/src/main/webapp/developers-guide/karaf-maven-plugin.conf >> Sat Nov 26 20:33:44 2011 >> @@ -54,10 +54,9 @@ Normally you should use the features or >> The {{karaf-maven-plugin}} provides several goals to help you create and >> validate features XML descriptors as well as leverage your features to >> create a custom Karaf distribution. >> >> || Goal || Description || >> -| >> {{[karaf:features-add-to-repository|karaf-maven-plugin-features-add-to-repository]}} >> | Copies all the bundles required for a given set of features into a >> directory \\ (e.g. for creating your own Karaf-based distribution) | >> -| >> {{[karaf:features-generate-descriptor|karaf-maven-plugin-features-generate-descriptor]}} >> | Generates a features XML descriptor for a set of bundles | >> +| >> {{[karaf:features-generate-descriptor|karaf-maven-plugin-features-generate-descriptor]}} >> | Generates a features XML descriptor for a set of bundles. Used in >> feature and kar packagings. | >> | >> {{[karaf:features-validate-descriptor|karaf-maven-plugin-features-validate-descriptor]}} >> | Validate a features XML descriptor by checking if all the required >> imports can be matched to exports | >> -| {{[karaf:features-create-kar|karaf-maven-plugin-features-create-kar]}} | >> Assemble a KAR archive from a features XML descriptor. | >> +| {{[karaf:features-create-kar|karaf-maven-plugin-features-create-kar]}} | >> Assemble a KAR archive from a features XML descriptor. Used in kar >> packaging.| >> >> >> h2. Instances and distributions goals >> @@ -66,4 +65,6 @@ Normally you should use the karaf-assemb >> The {{karaf-maven-plugin}} helps you to build custom Karaf distributions or >> archives existing Karaf instances: >> >> || Goal || Description || >> -| >> {{[karaf:instance-create-archive|karaf-maven-plugin-instance-create-archive]}} >> | Package a server archive from an assembled server. | >> +| {{karaf:install-kars}} | Assemble a server from maven feature-repo and >> kar dependencies. Used in karaf-assembly packaging. See >> {{[karaf-assembly|custom-distribution]}}. | >> +| >> {{[karaf:instance-create-archive|karaf-maven-plugin-instance-create-archive]}} >> | Package a server archive from an assembled server. . Used in >> karaf-assembly packaging. See also >> {{[karaf-assembly|custom-distribution]}}.| >> +| >> {{[karaf:features-add-to-repository|karaf-maven-plugin-features-add-to-repository]}} >> | (old style manual assemblies) Copies all the bundles required for a given >> set of features into a directory \\ (e.g. for creating your own Karaf-based >> distribution) | >> >> > > > -- > Glen Mazza > Talend Community Coders > http://coders.talend.com > blog: http://www.jroller.com/gmazza >
