You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@karaf.apache.org by "Achim Nierbeck (JIRA)" <ji...@apache.org> on 2010/11/28 00:39:37 UTC
[jira] Created: (KARAF-303) Documentation for available Features
and how they might be configured
Documentation for available Features and how they might be configured
---------------------------------------------------------------------
Key: KARAF-303
URL: https://issues.apache.org/jira/browse/KARAF-303
Project: Karaf
Issue Type: Improvement
Components: documentation
Reporter: Achim Nierbeck
The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
does lack information of what kind of additional features can be installed.
Two things should be of Interest here:
1. What is the feature good for
2. How can it be configured
Just one brief example using features for http and war:
description:
http - is a standard webcontainer which provides standard services which are needed for webconsole
war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
configuration:
following configurations are available for the webcontainer:
...
org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
...
In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
Re: [jira] Created: (KARAF-303) Documentation for available Features
and how they might be configured
Posted by Achim Nierbeck <bc...@googlemail.com>.
Hi All,
I added some proposals on both KARAF-53 and KARAF-303, so what do you
think :)
Greetings from a snowy Germany, Achim
P.S. it usually dosn't snow that much in Karlsruhe :)
> Hi Achim,
> Schema is a bit outdated. It was submitted in KARAF-53. I going to work on
> this issue in next week to push it in 2.2/2.3 release.
>
> Best regards,
> Lukasz
>
> -----Original Message-----
> From: Achim Nierbeck [mailto:bcanhome@googlemail.com]
> Sent: Sunday, November 28, 2010 4:25 PM
> To: dev@karaf.apache.org
> Subject: Re: [jira] Created: (KARAF-303) Documentation for available
> Features and how they might be configured
>
> Sounds great, this way it's only one place to edit.
>
> Btw, do we have an xml-schema for the features.xml?
>
>
>
> 2010/11/28 Guillaume Nodet <gn...@gmail.com>
>
>> What about embedding this information in the xml descriptor so that we
>> can generate some users guide pages and display that information from
>> the karaf console. That's already what we do for commands...
>>
>> On Sunday, November 28, 2010, Achim Nierbeck (JIRA) <ji...@apache.org>
>> wrote:
>>> Documentation for available Features and how they might be configured
>>> ---------------------------------------------------------------------
>>>
>>> Key: KARAF-303
>>> URL: https://issues.apache.org/jira/browse/KARAF-303
>>> Project: Karaf
>>> Issue Type: Improvement
>>> Components: documentation
>>> Reporter: Achim Nierbeck
>>>
>>>
>>> The documentation for 2.2.0 (and before that)
>> http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
>>> does lack information of what kind of additional features can be
>> installed.
>>> Two things should be of Interest here:
>>> 1. What is the feature good for
>>> 2. How can it be configured
>>>
>>> Just one brief example using features for http and war:
>>> description:
>>> http - is a standard webcontainer which provides standard services which
>> are needed for webconsole
>>> war - enables the fullfeature set of the webcontainer by enabling JSP
>> support and deployment of non OSGi wars ...
>>> configuration:
>>> following configurations are available for the webcontainer:
>>> ...
>>> org.osgi.service.http.port=8181 - entry for the port the webcontainer is
>> running on
>>> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for
> the
>> place to look for an additional jetty configuration
>>> ...
>>> In case of the jetty even some special configurations on how to connect
>> jetty with the jaas should be documented.
>>> I'm sure this isn't the only place where some more detailed
> documentation
>> is helpful for the user.
>>>
>>>
>>>
>>> --
>>> This message is automatically generated by JIRA.
>>> -
>>> You can reply to this email to add a comment to the issue online.
>>>
>>>
>> --
>> Cheers,
>> Guillaume Nodet
>> ------------------------
>> Blog: http://gnodet.blogspot.com/
>> ------------------------
>> Open Source SOA
>> http://fusesource.com
>>
RE: [jira] Created: (KARAF-303) Documentation for available Features and how they might be configured
Posted by Łukasz Dywicki <lu...@code-house.org>.
Hi Achim,
Schema is a bit outdated. It was submitted in KARAF-53. I going to work on
this issue in next week to push it in 2.2/2.3 release.
Best regards,
Lukasz
-----Original Message-----
From: Achim Nierbeck [mailto:bcanhome@googlemail.com]
Sent: Sunday, November 28, 2010 4:25 PM
To: dev@karaf.apache.org
Subject: Re: [jira] Created: (KARAF-303) Documentation for available
Features and how they might be configured
Sounds great, this way it's only one place to edit.
Btw, do we have an xml-schema for the features.xml?
2010/11/28 Guillaume Nodet <gn...@gmail.com>
> What about embedding this information in the xml descriptor so that we
> can generate some users guide pages and display that information from
> the karaf console. That's already what we do for commands...
>
> On Sunday, November 28, 2010, Achim Nierbeck (JIRA) <ji...@apache.org>
> wrote:
> > Documentation for available Features and how they might be configured
> > ---------------------------------------------------------------------
> >
> > Key: KARAF-303
> > URL: https://issues.apache.org/jira/browse/KARAF-303
> > Project: Karaf
> > Issue Type: Improvement
> > Components: documentation
> > Reporter: Achim Nierbeck
> >
> >
> > The documentation for 2.2.0 (and before that)
> http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> > does lack information of what kind of additional features can be
> installed.
> > Two things should be of Interest here:
> > 1. What is the feature good for
> > 2. How can it be configured
> >
> > Just one brief example using features for http and war:
> > description:
> > http - is a standard webcontainer which provides standard services which
> are needed for webconsole
> > war - enables the fullfeature set of the webcontainer by enabling JSP
> support and deployment of non OSGi wars ...
> > configuration:
> > following configurations are available for the webcontainer:
> > ...
> > org.osgi.service.http.port=8181 - entry for the port the webcontainer is
> running on
> > org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for
the
> place to look for an additional jetty configuration
> > ...
> > In case of the jetty even some special configurations on how to connect
> jetty with the jaas should be documented.
> >
> > I'm sure this isn't the only place where some more detailed
documentation
> is helpful for the user.
> >
> >
> >
> >
> > --
> > This message is automatically generated by JIRA.
> > -
> > You can reply to this email to add a comment to the issue online.
> >
> >
>
> --
> Cheers,
> Guillaume Nodet
> ------------------------
> Blog: http://gnodet.blogspot.com/
> ------------------------
> Open Source SOA
> http://fusesource.com
>
Re: [jira] Created: (KARAF-303) Documentation for available Features
and how they might be configured
Posted by Achim Nierbeck <bc...@googlemail.com>.
Sounds great, this way it's only one place to edit.
Btw, do we have an xml-schema for the features.xml?
2010/11/28 Guillaume Nodet <gn...@gmail.com>
> What about embedding this information in the xml descriptor so that we
> can generate some users guide pages and display that information from
> the karaf console. That's already what we do for commands...
>
> On Sunday, November 28, 2010, Achim Nierbeck (JIRA) <ji...@apache.org>
> wrote:
> > Documentation for available Features and how they might be configured
> > ---------------------------------------------------------------------
> >
> > Key: KARAF-303
> > URL: https://issues.apache.org/jira/browse/KARAF-303
> > Project: Karaf
> > Issue Type: Improvement
> > Components: documentation
> > Reporter: Achim Nierbeck
> >
> >
> > The documentation for 2.2.0 (and before that)
> http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> > does lack information of what kind of additional features can be
> installed.
> > Two things should be of Interest here:
> > 1. What is the feature good for
> > 2. How can it be configured
> >
> > Just one brief example using features for http and war:
> > description:
> > http - is a standard webcontainer which provides standard services which
> are needed for webconsole
> > war - enables the fullfeature set of the webcontainer by enabling JSP
> support and deployment of non OSGi wars ...
> > configuration:
> > following configurations are available for the webcontainer:
> > ...
> > org.osgi.service.http.port=8181 - entry for the port the webcontainer is
> running on
> > org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the
> place to look for an additional jetty configuration
> > ...
> > In case of the jetty even some special configurations on how to connect
> jetty with the jaas should be documented.
> >
> > I'm sure this isn't the only place where some more detailed documentation
> is helpful for the user.
> >
> >
> >
> >
> > --
> > This message is automatically generated by JIRA.
> > -
> > You can reply to this email to add a comment to the issue online.
> >
> >
>
> --
> Cheers,
> Guillaume Nodet
> ------------------------
> Blog: http://gnodet.blogspot.com/
> ------------------------
> Open Source SOA
> http://fusesource.com
>
Re: [jira] Created: (KARAF-303) Documentation for available Features
and how they might be configured
Posted by Guillaume Nodet <gn...@gmail.com>.
What about embedding this information in the xml descriptor so that we
can generate some users guide pages and display that information from
the karaf console. That's already what we do for commands...
On Sunday, November 28, 2010, Achim Nierbeck (JIRA) <ji...@apache.org> wrote:
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: documentation
> Reporter: Achim Nierbeck
>
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
>
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
>
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
>
>
>
>
> --
> This message is automatically generated by JIRA.
> -
> You can reply to this email to add a comment to the issue online.
>
>
--
Cheers,
Guillaume Nodet
------------------------
Blog: http://gnodet.blogspot.com/
------------------------
Open Source SOA
http://fusesource.com
[jira] Issue Comment Edited: (KARAF-303) Documentation for
available Features and how they might be configured
Posted by "Achim Nierbeck (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12966028#action_12966028 ]
Achim Nierbeck edited comment on KARAF-303 at 12/2/10 4:10 AM:
---------------------------------------------------------------
I agree with you that a duplication of the documentation should be prevented.
Here some pros and cons that come to my mind:
Pros:
- Only one place to edit documentation
- The provider of the bundle already does this
Cons:
- What if the Feature has more than one bundle that contains meta-type information?
- What if the bundle doesn't contain any information at all?
Open:
- would it be possible to parse this meta-type documentation for usage in the online-documentation?
- again would it be possible to use this meta-type documentation as documentation attached to the feature:info command and in the webconsole?
If we get around the open points and find a good solution for the cons I'm with you that there should be only one place for the documentation.
was (Author: achim_nierbeck):
I agree with you that a duplication of the documentation should be prevented.
Here some pros and cons that come to my mind:
Pros:
- Only one place to edit documentation
- The provider of the bundle already does this
Cons:
- What if the Feature has more than one bundle that contains meta-type information?
- What if the bundle doesn't contain any information at all?
Open:
- would it be possible to parse this meta-type documentation for usage in the online-documentation?
- again would it be possible to use this meta-type documentation as documentation attached to the feature:info command and in the webconsole?
If we get arround the open points and find a good solution for the cons I'm with you that there should be only one place for the documentation.
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: documentation
> Reporter: Achim Nierbeck
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (KARAF-303) Documentation for available Features
and how they might be configured
Posted by "Łukasz Dywicki (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12967267#action_12967267 ]
Łukasz Dywicki commented on KARAF-303:
--------------------------------------
Hi, I would opt for metatype as existing, ready to use format. Documentation can be created by XSLT transformation, even on the fly..
We only need tool to read metatype descriptors to display additional info in features:info command output.
Best regards,
Lukasz
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: documentation
> Reporter: Achim Nierbeck
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (KARAF-303) Documentation for available Features
and how they might be configured
Posted by "Achim Nierbeck (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12966028#action_12966028 ]
Achim Nierbeck commented on KARAF-303:
--------------------------------------
I agree with you that a duplication of the documentation should be prevented.
Here some pros and cons that come to my mind:
Pros:
- Only one place to edit documentation
- The provider of the bundle already does this
Cons:
- What if the Feature has more than one bundle that contains meta-type information?
- What if the bundle doesn't contain any information at all?
Open:
- would it be possible to parse this meta-type documentation for usage in the online-documentation?
- again would it be possible to use this meta-type documentation as documentation attached to the feature:info command and in the webconsole?
If we get arround the open points and find a good solution for the cons I'm with you that there should be only one place for the documentation.
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: documentation
> Reporter: Achim Nierbeck
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (KARAF-303) Documentation for available Features
and how they might be configured
Posted by "Achim Nierbeck (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12965888#action_12965888 ]
Achim Nierbeck commented on KARAF-303:
--------------------------------------
This would be my "proposal" on how to document this.
{code}
<feature name="http" version="${project.version}" resolver="(obr)">
<description>
Provides a standard web container for standard services and http service which are needed as runtime for the webconsole feature.
</description>
<config name="org.ops4j.pax.web">
org.osgi.service.http.port=8181
org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml
</config>
<configurationDescription>
<confentry name="org.osgi.service.http.port" defaultValue="8181">The port the web container is running on</confentry>
<confentry name="org.ops4j.pax.web.config.file" defaultValue="${karaf.base}/etc/jetty.xml">External location to look for an additional web container (usually jetty) configuration file</confentry>
</configurationDescription>
<feature version="[7.0,8.0)">jetty</feature>
<bundle>mvn:org.ops4j.pax.web/pax-web-api/${pax.web.version}</bundle>
<bundle>mvn:org.ops4j.pax.web/pax-web-spi/${pax.web.version}</bundle>
<bundle>mvn:org.ops4j.pax.web/pax-web-runtime/${pax.web.version}</bundle>
<bundle>mvn:org.ops4j.pax.web/pax-web-jetty/${pax.web.version}</bundle>
</feature>
{code}
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: documentation
> Reporter: Achim Nierbeck
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] [Updated] (KARAF-303) Documentation for available Features
and how they might be configured
Posted by "Christian Schneider (Updated) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Christian Schneider updated KARAF-303:
--------------------------------------
Fix Version/s: (was: 3.0.0)
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: karaf-documentation
> Reporter: Achim Nierbeck
> Fix For: 3.1.0
>
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] [Commented] (KARAF-303) Documentation for available Features
and how they might be configured
Posted by "Christian Schneider (Commented) (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=13224330#comment-13224330 ]
Christian Schneider commented on KARAF-303:
-------------------------------------------
I think it would be great to have a shell command that displays the metatype information for config pids like:
config:info <pid>
or
config:info <pid> <property name>
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: karaf-documentation
> Reporter: Achim Nierbeck
> Fix For: 3.1.0
>
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
If you think it was sent incorrectly, please contact your JIRA administrators: https://issues.apache.org/jira/secure/ContactAdministrators!default.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira
[jira] Commented: (KARAF-303) Documentation for available Features
and how they might be configured
Posted by "Ioannis Canellos (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12964564#action_12964564 ]
Ioannis Canellos commented on KARAF-303:
----------------------------------------
I like this one.
We can also add these info to the feature descriptors so that they can be displayed by
features:list and features:info commands.
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: documentation
> Reporter: Achim Nierbeck
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] Commented: (KARAF-303) Documentation for available Features
and how they might be configured
Posted by "Guillaume Nodet (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12965898#action_12965898 ]
Guillaume Nodet commented on KARAF-303:
---------------------------------------
Shouldn't we reuse the meta-type description directly ?
<metatype:MetaData xmlns:metatype="http://www.osgi.org/xmlns/metatype/v1.0.0" localization="OSGI-INF/metatype/metatype">
<OCD id="org.apache.karaf.shell" name="%shell.name" description="%shell.description">
<AD id="sshPort" type="Integer" default="8101" name="%sshPort.name" description="%sshPort.description"/>
<AD id="sshHost" type="String" default="0.0.0.0" name="%sshHost.name" description="%sshHost.description"/>
<AD id="sshRealm" type="String" default="karaf" name="%sshRealm.name" description="%sshRealm.description"/>
<AD id="hostKey" type="String" default="${karaf.base}/etc/host.key" name="%hostKey.name" description="%hostKey.description"/>
</OCD>
<Designate pid="org.apache.karaf.shell">
<Object ocdref="org.apache.karaf.shell"/>
</Designate>
</metatype:MetaData>
I know it's not really pretty, just wondering if we want to duplicate the information ...
Or should we just embed comments in the config section ?
<config name="org.ops4j.pax.web">
# The port the web container is running on
org.osgi.service.http.port=8181
# External location to look for an additional web container (usually jetty) configuration file
org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml
</config>
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: documentation
> Reporter: Achim Nierbeck
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
-
You can reply to this email to add a comment to the issue online.
[jira] [Updated] (KARAF-303) Documentation for available Features
and how they might be configured
Posted by "Jean-Baptiste Onofré (JIRA)" <ji...@apache.org>.
[ https://issues.apache.org/jira/browse/KARAF-303?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]
Jean-Baptiste Onofré updated KARAF-303:
---------------------------------------
Fix Version/s: 3.1.0
3.0.0
> Documentation for available Features and how they might be configured
> ---------------------------------------------------------------------
>
> Key: KARAF-303
> URL: https://issues.apache.org/jira/browse/KARAF-303
> Project: Karaf
> Issue Type: Improvement
> Components: documentation
> Reporter: Achim Nierbeck
> Fix For: 3.0.0, 3.1.0
>
>
> The documentation for 2.2.0 (and before that) http://karaf.apache.org/manual/2.1.99-SNAPSHOT/index.html
> does lack information of what kind of additional features can be installed.
> Two things should be of Interest here:
> 1. What is the feature good for
> 2. How can it be configured
> Just one brief example using features for http and war:
> description:
> http - is a standard webcontainer which provides standard services which are needed for webconsole
> war - enables the fullfeature set of the webcontainer by enabling JSP support and deployment of non OSGi wars ...
> configuration:
> following configurations are available for the webcontainer:
> ...
> org.osgi.service.http.port=8181 - entry for the port the webcontainer is running on
> org.ops4j.pax.web.config.file=${karaf.base}/etc/jetty.xml - entry for the place to look for an additional jetty configuration
> ...
> In case of the jetty even some special configurations on how to connect jetty with the jaas should be documented.
> I'm sure this isn't the only place where some more detailed documentation is helpful for the user.
--
This message is automatically generated by JIRA.
For more information on JIRA, see: http://www.atlassian.com/software/jira