Karaf(OpenDaylight)：如何在Feature安装时自动复制文件

Absolutely! You don’t need to rely on manual Maven copy steps—Karaf’s Feature definition system has built-in support for automatically deploying configuration files when a feature is installed. Here’s how to set it up properly:

1. Define the Resource in Your Feature XML #

In your feature descriptor (usually src/main/resources/features.xml), add a <resource> element inside your feature definition. This tells Karaf to copy the specified file to the target location during installation.

Example:

<feature name="features-myfeature" version="1.0.0" description="My Custom Feature">
    <!-- Your existing bundles go here -->
    <bundle>mvn:com.example/my-core-bundle/1.0.0</bundle>

    <!-- Add the resource for your config file -->
    <resource>
        <!-- Source: Maven coordinates pointing to your config file -->
        <uri>mvn:com.example/my-feature-project/1.0.0:cfg:/configs/my-app.cfg</uri>
        <!-- Target: Path where the file should be copied (uses Karaf system properties) -->
        <target>${karaf.etc}/my-app.cfg</target>
        <!-- Optional: Delete the file when the feature is uninstalled -->
        <delete>true</delete>
    </resource>
</feature>

2. Breakdown of the Resource URI #

The uri follows the format mvn:<groupId>:<artifactId>:<version>:<type>:<path>:

• mvn:: Indicates this is a Maven artifact resource
• com.example/my-feature-project/1.0.0: Your project's Maven coordinates
• cfg: The type of resource (can be file, cfg, or any custom type—cfg is standard for configuration files)
• /configs/my-app.cfg: The path to your config file within the project's classpath (make sure this file is included in your Maven build)

3. Ensure the Config File is Packaged in Your Maven Project #

Make sure your config file is included in the Maven artifact so Karaf can access it. Add this to your pom.xml if it’s not already there:

<build>
    <resources>
        <resource>
            <directory>src/main/resources</directory>
            <includes>
                <include>configs/**/*.cfg</include>
            </includes>
        </resource>
    </resources>
</build>

4. Build and Deploy the Feature #

When you build your project with mvn clean install, the Karaf Maven Plugin will package the feature descriptor along with the config file. Once you add your feature repository to Karaf (feature:repo-add mvn:com.example/my-feature-project/1.0.0/xml/features), running features:install features-myfeature will automatically copy my-app.cfg to ${karaf.etc}.

Key Notes #

• System Properties: Use Karaf’s built-in properties like ${karaf.etc}, ${karaf.data}, or ${karaf.home} for target paths to keep your configuration portable.
• Uninstallation: Setting <delete>true</delete> will remove the config file when the feature is uninstalled (use this carefully if users might have modified the file!).
• Permissions: Ensure the Karaf process has write access to the target directory (most default directories like etc are writable out of the box).

This approach integrates the config deployment directly into Karaf’s feature lifecycle, making it more reliable than manual Maven copy steps—users get a seamless install experience without extra setup.

内容的提问来源于stack exchange，提问作者LostInTheFrequencyDomain