DC/OS Maven Plugin

Maven plugin to deploy containerized java applications to DC/OS

Containerized applications deployed on DC/OS are realized through Marathon. You can find more information about Marathon and container deployment with DC/OS here:

• Marathon documentation
• DC/OS 101 tutorials

Configuration

Example plugin configuration:

    <build>
        <plugins>
            <plugin>
                <groupId>dcos</groupId>
                <artifactId>dcos-maven-plugin</artifactId>
                <version>0.1</version>
                <configuration>
                    <dcosUrl>http://junterste-elasticl-1j6yqdjx1qa8f-2107866714.us-west-2.elb.amazonaws.com/</dcosUrl>
                    <ignoreSslCertificate>true</ignoreSslCertificate>
                </configuration>
            </plugin>
        </plugins>
    </build>

appDefinition

By default, you need to place your application definition in the app-definition.json. You can change this filename with the appDefinition parameter.

dcosTokenFile

By default, you need to place your DC/OS authentication token in the .dcos-token file. You can change this filename with the dcosTokenFile parameter.

dcosUrl

You can configure the URL of your DC/OS with the dcosUrl configuration node in your plugin configuration within your pom.xml.

ignoreSslCertificate

If you want to skip ssl certificate verification, e.g. you have a self-signed certificate, you can set configure <ignoreSslCertificate>true</ignoreSslCertificate> to disable this verification.

How do I get my DC/OS auth token?!

If you are using the DC/OS CLI, just do the following:

# log in
dcos auth login

# get the token
dcos config show core.dcos_acs_token

Commands

dcos:deploy

If you want to create or update your application, you want to use mvn dcos:deploy. This will send the file configured as appDefinition to DC/OS.

dcos:restart

If you just want to restart your application, for example you updated the docker image in your registry, you want to use mvn dcos:restart. No application definition will be sent to DC/OS, only the restart trigger for the defined application ID will be sent.

dcos:uploadArtifact

If you run mvn clean package dcos:uploadArtifact, this plugin will take the newly built jar file and publish it to your configured nexus server, see example configuration here.

dcos:deployUCR

If you successfully uploaded your jar file to your configured nexus server (no matter if you used the maven plugin or did a manual upload) and you have an app definition like this, the mvn dcos:deployUCR command will replace your placeholders in your application.json with your nexus URLs and deploy this to marathon.

Docker Maven Plugin

Using the plugin

This plugin plays well with the docker-maven-plugin of spotify. You might want to use this plugin to build and push your docker images. After using

mvn docker:build docker:push

to update your docker image in your registry, you might want to use

mvn dcos:restart

to restart your application on DC/OS. Combined: mvn docker:build docker:push dcos:restart

Attention: When using mvn dcos:restart please make sure you you are using the forcePullImage flag in your marathon configuration to disable image caching, for example:

{
  "type": "DOCKER",
  "docker": {
    "image": "your/image",
    "forcePullImage": true
  }
}

Configuring docker hub credentials

You need to configure your docker hub login credentials within your maven ~/.m2/settings.xml configuration:

<servers>
   <server>
      <id>docker-hub</id>
      <username>your-user</username>
      <password>your-password</password>
      <configuration>
         <email>your@user.com</email>
      </configuration>
   </server>
</servers>

Limitations

Security

Security is bound to DC/OS auth tokens which have defined time to life of 5 days.

Run example

You can find a complete example using a Spring Boot web application in the sample/spring-boot-sample folder.

Docker

<pluginRepositories>
   <pluginRepository>
      <id>mesosphere-repo</id>
      <name>Mesosphere Repo</name>
      <url>http://downloads.mesosphere.io/maven</url>
   </pluginRepository>
</pluginRepositories>

<build>
   <plugins>
      <plugin>
         <groupId>com.spotify</groupId>
         <artifactId>docker-maven-plugin</artifactId>
         <version>0.4.13</version>
         <configuration>
            <serverId>docker-hub</serverId>
            <imageName>unterstein/dcos-maven-spring-sample</imageName>
            <baseImage>java</baseImage>
            <entryPoint>["java", "-jar", "/${project.build.finalName}.jar"]</entryPoint>
            <exposes>
               <expose>8080</expose>
            </exposes>
            <resources>
               <resource>
                  <targetPath>/</targetPath>
                  <directory>${project.build.directory}</directory>
                  <include>${project.build.finalName}.jar</include>
               </resource>
            </resources>
         </configuration>
      </plugin>
      <plugin>
         <groupId>dcos</groupId>
         <artifactId>dcos-maven-plugin</artifactId>
         <version>0.2</version>
         <configuration>
            <dcosUrl>http://junterste-elasticl-nne0d6r823fs-2010862002.eu-central-1.elb.amazonaws.com/</dcosUrl>
            <ignoreSslCertificate>true</ignoreSslCertificate>
         </configuration>
      </plugin>
   </plugins>
</build>

You only need to adapt the configuration (.dcos-token & pom.xml) and run

mvn clean package docker:build docker:push dcos:deploy

Groups

<pluginRepositories>
   <pluginRepository>
      <id>mesosphere-repo</id>
      <name>Mesosphere Repo</name>
      <url>http://downloads.mesosphere.io/maven</url>
   </pluginRepository>
</pluginRepositories>

<build>
   <plugins>
      <plugin>
         <groupId>dcos</groupId>
         <artifactId>dcos-maven-plugin</artifactId>
         <version>0.2</version>
         <configuration>
            <dcosUrl>http://junterste-elasticl-nne0d6r823fs-2010862002.eu-central-1.elb.amazonaws.com/</dcosUrl>
            <deployable>group</deployable>
            <ignoreSslCertificate>true</ignoreSslCertificate>
         </configuration>
      </plugin>
   </plugins>
</build>

Pods

<pluginRepositories>
   <pluginRepository>
      <id>mesosphere-repo</id>
      <name>Mesosphere Repo</name>
      <url>http://downloads.mesosphere.io/maven</url>
   </pluginRepository>
</pluginRepositories>

<build>
   <plugins>
      <plugin>
         <groupId>dcos</groupId>
         <artifactId>dcos-maven-plugin</artifactId>
         <version>0.2</version>
         <configuration>
            <dcosUrl>http://junterste-elasticl-nne0d6r823fs-2010862002.eu-central-1.elb.amazonaws.com/</dcosUrl>
            <deployable>pod</deployable>
            <ignoreSslCertificate>true</ignoreSslCertificate>
         </configuration>
      </plugin>
   </plugins>
</build>

For sure docker can be combined with groups and pods as well.

Versions

0.4

• Introduced new support for UCR and nexus support #15
• Commands dcos:deployUCR and dcos:uploadArtifact were added, see example app definition and pom.xml

0.3

• Fixes #7 by changing default name for marathon configurations to application.json
• Fixes #11 by enabling auto detection for apps, groups and pods
• DEPRECATION: Usage of app-definition.json is deprecated in favor of application.json and will be removed in later versions

0.2

• Fixes #2 by adding support for groups
• Fixes #3 by adding support for pods

0.1

• Initial version enabling dcos:deploy and dcos:restart