karaf-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Guillaume Nodet (JIRA)" <j...@apache.org>
Subject [jira] Commented: (KARAF-303) Documentation for available Features and how they might be configured
Date Wed, 01 Dec 2010 22:48:13 GMT

    [ 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.


Mime
View raw message