Packaging Yamcs¶

Maven is a build tool, and so running Yamcs through Maven is primarily intended for development and for creating prototypes. In a production environment, you may want to run Yamcs without Maven.

This plugin includes a bundle goal, which supports two packaging approaches:

Bundle everything (Yamcs + Yamcs Plugins + Your Project) in one single distribution
Bundle only your project

Bundling everything together is convenient, whereas the split approach allows you to make use of official Yamcs distributions.

In both cases the bundle goal of the yamcs-maven-plugin binds to the Maven package lifecycle phase. This makes Maven generate a Yamcs application with the command mvn package.

The resulting artifact can be used as input to platform-specific packaging tools, for example to create an RPM or DEB package.

Note

The bundle goal supports only a limited set of options. If you require to have more control over the layout and contents of your package, use other Maven plugins such as maven-assembly-plugin.

All-in-one¶

This example bundles Yamcs together with your extensions and configurations in one integrated distribution.

<project>
  ...
  <packaging>jar</packaging>

  <properties>
    <yamcsVersion>5.10.0</yamcsVersion>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.yamcs</groupId>
      <artifactId>yamcs-core</artifactId>
      <version>${yamcsVersion}</version>
    </dependency>
    <dependency>
      <groupId>org.yamcs</groupId>
      <artifactId>yamcs-web</artifactId>
      <version>${yamcsVersion}</version>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.yamcs</groupId>
        <artifactId>yamcs-maven-plugin</artifactId>
        <version>1.3.5</version>
        <executions>
          <execution>
            <id>bundle-yamcs</id>
            <phase>package</phase>
            <goals>
              <goal>bundle</goal>
            </goals>
            <configuration>
              <formats>
                <format>tar.gz</format>
                <format>zip</format>
              </formats>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>

Project Only¶

This example bundles only your extensions and configurations. The generated package can be extracted into an existing Yamcs installation directory.

Set the Maven scope of standard Yamcs dependencies to provided. This way they can be used during compilation, while the bundle goal will ignore them.

Set also includeDefaultWrappers to false to prevent the yamcsd and yamcsadmin shell scripts from being added to your package. These are already included in official Yamcs core builds.

<project>
  ...
  <packaging>jar</packaging>

  <properties>
    <yamcsVersion>5.10.0</yamcsVersion>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.yamcs</groupId>
      <artifactId>yamcs-core</artifactId>
      <version>${yamcsVersion}</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>org.yamcs</groupId>
      <artifactId>yamcs-web</artifactId>
      <version>${yamcsVersion}</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.yamcs</groupId>
        <artifactId>yamcs-maven-plugin</artifactId>
        <version>1.3.5</version>
        <executions>
          <execution>
            <id>bundle-yamcs</id>
            <phase>package</phase>
            <goals>
              <goal>bundle</goal>
            </goals>
            <configuration>
              <includeDefaultWrappers>false</includeDefaultWrappers>
              <formats>
                <format>tar.gz</format>
                <format>zip</format>
              </formats>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>

Combination¶

New in version 1.2.12.

What if you want to mark your dependencies as provided, and at the same time also make a bundle with those dependencies included. You can do so by setting the scope property on the bundle configuration to compile. The default scope if unset, is runtime, which excludes provided dependencies.

<project>
  ...
  <packaging>jar</packaging>

  <properties>
    <yamcsVersion>5.10.0</yamcsVersion>
  </properties>

  <dependencies>
    <dependency>
      <groupId>org.yamcs</groupId>
      <artifactId>yamcs-core</artifactId>
      <version>${yamcsVersion}</version>
      <scope>provided</scope>
    </dependency>
    <dependency>
      <groupId>org.yamcs</groupId>
      <artifactId>yamcs-web</artifactId>
      <version>${yamcsVersion}</version>
      <scope>provided</scope>
    </dependency>
  </dependencies>

  <build>
    <plugins>
      <plugin>
        <groupId>org.yamcs</groupId>
        <artifactId>yamcs-maven-plugin</artifactId>
        <version>1.3.5</version>
        <executions>
          <execution>
            <id>bundle-yamcs</id>
            <phase>package</phase>
            <goals>
              <goal>bundle</goal>
            </goals>
            <configuration>
              <scope>compile</scope>
              <formats>
                <format>tar.gz</format>
                <format>zip</format>
              </formats>
            </configuration>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
  ...
</project>