{"data":{"markdownRemark":{"html":"

Building via Docker

\n

Before you begin make sure your model is added inside org.models package, and registered inside the main class. You should also confirm being able to run locally before deploying.

\n

Building using SBT

\n

The first step is to add the docker & assembly plugin to your environment. You can do this by going to your .sbt directory. Choosing the correct version you will see a 'plugins.sbt' file (this step should be familiar if using SBT and Eclipse; however, if the file/folder is missing you will need to add them) and add the following.

\n

plugins.sbt

\n
addSbtPlugin(\"com.eed3si9n\" % \"sbt-assembly\" % \"0.14.6\")\n\naddSbtPlugin(\"se.marcuslonnberg\" % \"sbt-docker\" % \"1.5.0\")\n\naddSbtPlugin(\"com.typesafe.sbt\" % \"sbt-native-packager\" % \"1.3.3\")
\n

To build in SBT make sure you have properly configured your build.sbt file. You'll need to add the below section to both enable the docker plugin, and configure how it will build your docker image.

\n

build.sbt

\n
//*** SBT ASSEMBLY ***\n\nassemblyMergeStrategy in assembly := {\n  case PathList(\"META-INF\", xs @ _*) => MergeStrategy.discard\n  //akka configuration files\n  case PathList(\"reference.conf\") => MergeStrategy.concat\n  case _ => MergeStrategy.first\n}\nassemblyJarName in assembly := \"simudyne-sbt-docker.jar\"\n\n\n//*** SBT DOCKER ***\n\nenablePlugins(sbtdocker.DockerPlugin)\n// Generating docker file\ndockerfile in docker := {\n  val artifact: File = assembly.value\n  val artifactTargetPath = s\"/${artifact.name}\"\n\n  new Dockerfile {\n    from(\"simudyne/scala-sbt:2.11.12.1.0.4\")\n\tcopy(baseDirectory(_ / \"simudyneSDK.properties\" ).value, s\"/simudyneSDK.properties\")\n    copy(artifact, artifactTargetPath)\n    entryPoint(\"java\", \"-jar\", artifactTargetPath)\n  }\n}\nimageNames in docker := Seq(\n  ImageName(s\"${name.value}-$simudyneVersion:latest\")\n)
\n

Build the image by running 'sbt docker' inside the project's folder. This will create a docker image using the dockerfile generated by sbt in a way defined inside 'build.sbt'.

\n

You can now proceed to 'Pushing with Docker Hub'

\n
\n

Properties File

\n

If you are using the default 'simudyneSDK.properties' file you can proceed. If however, you are using multiple '.properties' files (such as a different setting for working with Spark) you will need to change a few things. First you must change the name used above to copy the file. Secondly you will need to edit the entryPoint to add the '-DsimudyneConfigFile' and/or '-DsimudyneConfigDir' as you would normally for running.

\n
\n

Building using Maven

\n

The first step is to make a few changes to your pom.xml (if not pulling from the quickstart repo). Make sure you add the jodatime and junit versions to your properties section.

\n

pom.xml

\n
<properties>\n  <maven.compiler.source>1.8</maven.compiler.source>\n  <maven.compiler.target>1.8</maven.compiler.target>\n  <jodatime.version>2.5</jodatime.version>\n  <junit.version>4.11</junit.version>\n</properties>
\n

You will then want to add the jodatime and junit dependencies to the section starting with ''

\n

pom.xml

\n
<dependency>\n  <groupId>junit</groupId>\n  <artifactId>junit</artifactId>\n  <version>${junit.version}</version>\n  <scope>test</scope>\n</dependency>\n<dependency>\n  <groupId>joda-time</groupId>\n  <artifactId>joda-time</artifactId>\n  <version>${jodatime.version}</version>\n</dependency>
\n

Finally you will add the plugins for assembling and dockerize-ing the project.

\n

pom.xml

\n
<plugin>\n  <groupId>org.apache.maven.plugins</groupId>\n  <artifactId>maven-shade-plugin</artifactId>\n  <version>2.4.1</version>\n  <executions>\n    <execution>\n    <phase>package</phase>\n    <goals>\n      <goal>shade</goal>\n    </goals>\n    <configuration>\n      <shadedArtifactAttached>true</shadedArtifactAttached>\n      <shadedClassifierName>allinone</shadedClassifierName>\n      <artifactSet>\n        <includes>\n          <include>*:*</include>\n        </includes>\n      </artifactSet>\n      <transformers>\n        <transformer implementation=\"org.apache.maven.plugins.shade.resource.AppendingTransformer\">\n          <resource>reference.conf</resource>\n        </transformer>\n        <transformer implementation=\"org.apache.maven.plugins.shade.resource.ManifestResourceTransformer\">\n          <main-Class>Main</main-Class>\n        </transformer>\n      </transformers>\n    </configuration>\n    </execution>\n  </executions>\n</plugin>\n<plugin>\n  <groupId>com.spotify</groupId>\n  <artifactId>docker-maven-plugin</artifactId>\n  <version>1.0.0</version>\n  <configuration>\n    <imageName>simudyne-maven-docker</imageName>\n    <baseImage>simudyne/scala-sbt:2.11.12.1.0.4</baseImage>\n    <entryPoint>[\"java\", \"-jar\", \"/${project.build.finalName}-allinone.jar\"]</entryPoint>\n    <!-- copy the service's jar file from target into the root directory of the image -->\n    <resources>\n      <resource>\n        <targetPath>/</targetPath>\n        <directory>${project.build.directory}</directory>\n        <include>${project.build.finalName}-allinone.jar</include>\n      </resource>\n      <resource>\n        <targetPath>/</targetPath>\n        <directory>.</directory>\n        <include>simudyneSDK.properties</include>\n      </resource>\n    </resources>\n  </configuration>\n</plugin>
\n
\n

Building the image

\n

Build the image by running 'mvn clean package docker:build -s settings.xml' inside the project's folder. This will create a docker image using the dockerfile generated by mvn in the way defined inside 'pom.xml'.

\n

You can now proceed to 'Pushing with Docker Hub'

\n
\n

Pushing to Docker Hub

\n

You will now push the docker image you have created to the Docker hub. You will want to replace the following things.

\n\n

An example of this would be simudyne/simu-repo:demos

\n
sudo docker tag [build] [account]/[repo-name]:[tag]\nsudo docker push [account]/[repo-name]
\n

You should be able to navigate to the Docker hub and confirm your image has been updated.

\n
\n

Logging into Docker

\n

You must first run 'docker login' before you can push or pull to a repo. This will automatically ask for your account and password.

\n
\n

Deployment on Server

\n

You must first log into the VM or server which you are deploying on. Please make sure the appropriate firewall and ports are made available based on either your public or intranet settings.

\n

Pull the image using the details you specified above.

\n
sudo docker pull [account]/[repo-name]:[tag]
\n

You will likely already be running a container if not please skip to the next step. However, if you are you need to stop the existing container.

\n
sudo docker ps #to identify the container ID\nsudo docker stop <containerID>
\n

You will then look for the exact image name, and then run it with the following configuration options.

\n\n

An example of this would be 'docker run -p 80:80 f3c0fa608b22 0.0.0.0 80'

\n
sudo docker images # to have a look at the available images and get ImageID\nsudo docker run -p <port>:<port> <ImageID> <ip> <port>
\n

Once completed you should be able to go to the IP or DNS address of the server you've deployed on (mind the port) and see the console as you would locally.

","headings":[{"value":"Building via Docker","depth":2},{"value":"Building using SBT","depth":3},{"value":"Building using Maven","depth":3},{"value":"Pushing to Docker Hub","depth":2},{"value":"Deployment on Server","depth":2}],"frontmatter":{"title":"Deploying via Docker","toc":null,"experimental":null}},"site":{"siteMetadata":{"title":"Simudyne Docs","latestVersion":"2.6"}}},"pageContext":{"absolutePath":"/home/vsts/work/1/s/content/2.0/reference/deployment/docker.md","versioned":true,"version":"2.0","kind":"reference","pagePath":"/reference/deployment/docker","chronology":{"prev":{"name":"Deployment","path":"/reference/deployment"},"next":{"name":"Run mode","path":"/reference/run_mode"}},"lastUpdated":"2026-04-21T13:56:54.827Z"}}