Deploying Spring Boot Applications

1. Deploying to the Cloud

Spring Boot’s executable jars are ready-made for most popular cloud PaaS (Platform-as-a-Service) providers. These providers tend to require that you “bring your own container”. They manage application processes (not Java applications specifically), so they need an intermediary layer that adapts your application to the cloud’s notion of a running process.spring-doc.cn

Two popular cloud providers, Heroku and Cloud Foundry, employ a “buildpack” approach. The buildpack wraps your deployed code in whatever is needed to start your application. It might be a JDK and a call to java, an embedded web server, or a full-fledged application server. A buildpack is pluggable, but ideally you should be able to get by with as few customizations to it as possible. This reduces the footprint of functionality that is not under your control. It minimizes divergence between development and production environments.spring-doc.cn

Ideally, your application, like a Spring Boot executable jar, has everything that it needs to run packaged within it.spring-doc.cn

In this section, we look at what it takes to get the application that we developed in the “Getting Started” section up and running in the Cloud.spring-doc.cn

1.1. Cloud Foundry

Cloud Foundry provides default buildpacks that come into play if no other buildpack is specified. The Cloud Foundry Java buildpack has excellent support for Spring applications, including Spring Boot. You can deploy stand-alone executable jar applications as well as traditional .war packaged applications.spring-doc.cn

Once you have built your application (by using, for example, mvn clean package) and have installed the cf command line tool, deploy your application by using the cf push command, substituting the path to your compiled .jar. Be sure to have logged in with your cf command line client before pushing an application. The following line shows using the cf push command to deploy an application:spring-doc.cn

$ cf push acloudyspringtime -p target/demo-0.0.1-SNAPSHOT.jar

In the preceding example, we substitute acloudyspringtime for whatever value you give cf as the name of your application.

See the cf push documentation for more options. If there is a Cloud Foundry manifest.yml file present in the same directory, it is considered.spring-doc.cn

At this point, cf starts uploading your application, producing output similar to the following example:spring-doc.cn

Uploading acloudyspringtime... OK
Preparing to start acloudyspringtime... OK
-----> Downloaded app package (8.9M)
-----> Java Buildpack Version: v3.12 (offline) | https://github.com/cloudfoundry/java-buildpack.git#6f25b7e
-----> Downloading Open Jdk JRE
       Expanding Open Jdk JRE to .java-buildpack/open_jdk_jre (1.6s)
-----> Downloading Open JDK Like Memory Calculator 2.0.2_RELEASE from https://java-buildpack.cloudfoundry.org/memory-calculator/trusty/x86_64/memory-calculator-2.0.2_RELEASE.tar.gz (found in cache)
       Memory Settings: -Xss349K -Xmx681574K -XX:MaxMetaspaceSize=104857K -Xms681574K -XX:MetaspaceSize=104857K
-----> Downloading Container Certificate Trust Store 1.0.0_RELEASE from https://java-buildpack.cloudfoundry.org/container-certificate-trust-store/container-certificate-trust-store-1.0.0_RELEASE.jar (found in cache)
       Adding certificates to .java-buildpack/container_certificate_trust_store/truststore.jks (0.6s)
-----> Downloading Spring Auto Reconfiguration 1.10.0_RELEASE from https://java-buildpack.cloudfoundry.org/auto-reconfiguration/auto-reconfiguration-1.10.0_RELEASE.jar (found in cache)
Checking status of app 'acloudyspringtime'...
  0 of 1 instances running (1 starting)
  ...
  0 of 1 instances running (1 starting)
  ...
  0 of 1 instances running (1 starting)
  ...
  1 of 1 instances running (1 running)

App started

Congratulations! The application is now live!spring-doc.cn

Once your application is live, you can verify the status of the deployed application by using the cf apps command, as shown in the following example:spring-doc.cn

$ cf apps
Getting applications in ...
OK

name                 requested state   instances   memory   disk   urls
...
acloudyspringtime    started           1/1         512M     1G     acloudyspringtime.cfapps.io
...

Once Cloud Foundry acknowledges that your application has been deployed, you should be able to find the application at the URI given. In the preceding example, you could find it at https://acloudyspringtime.cfapps.io/.spring-doc.cn

1.1.1. Binding to Services

By default, metadata about the running application as well as service connection information is exposed to the application as environment variables (for example: $VCAP_SERVICES). This architecture decision is due to Cloud Foundry’s polyglot (any language and platform can be supported as a buildpack) nature. Process-scoped environment variables are language agnostic.spring-doc.cn

Environment variables do not always make for the easiest API, so Spring Boot automatically extracts them and flattens the data into properties that can be accessed through Spring’s Environment abstraction, as shown in the following example:spring-doc.cn

Java

import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.Environment;
import org.springframework.stereotype.Component;

@Component
public class MyBean implements EnvironmentAware {

    private String instanceId;

    @Override
    public void setEnvironment(Environment environment) {
        this.instanceId = environment.getProperty("vcap.application.instance_id");
    }

    // ...

}

Kotlin

import org.springframework.context.EnvironmentAware
import org.springframework.core.env.Environment
import org.springframework.stereotype.Component

@Component
class MyBean : EnvironmentAware {

    private var instanceId: String? = null

    override fun setEnvironment(environment: Environment) {
        instanceId = environment.getProperty("vcap.application.instance_id")
    }

    // ...

}

All Cloud Foundry properties are prefixed with vcap. You can use vcap properties to access application information (such as the public URL of the application) and service information (such as database credentials). See the CloudFoundryVcapEnvironmentPostProcessor Javadoc for complete details.spring-doc.cn

The Java CFEnv project is a better fit for tasks such as configuring a DataSource.

1.2. Kubernetes

Spring Boot auto-detects Kubernetes deployment environments by checking the environment for "*_SERVICE_HOST" and "*_SERVICE_PORT" variables. You can override this detection with the spring.main.cloud-platform configuration property.spring-doc.cn

Spring Boot helps you to manage the state of your application and export it with HTTP Kubernetes Probes using Actuator.spring-doc.cn

1.2.1. Kubernetes Container Lifecycle

When Kubernetes deletes an application instance, the shutdown process involves several subsystems concurrently: shutdown hooks, unregistering the service, removing the instance from the load-balancer… Because this shutdown processing happens in parallel (and due to the nature of distributed systems), there is a window during which traffic can be routed to a pod that has also begun its shutdown processing.spring-doc.cn

You can configure a sleep execution in a preStop handler to avoid requests being routed to a pod that has already begun shutting down. This sleep should be long enough for new requests to stop being routed to the pod and its duration will vary from deployment to deployment. The preStop handler can be configured by using the PodSpec in the pod’s configuration file as follows:spring-doc.cn

spec:
  containers:
  - name: "example-container"
    image: "example-image"
    lifecycle:
      preStop:
        exec:
          command: ["sh", "-c", "sleep 10"]

Once the pre-stop hook has completed, SIGTERM will be sent to the container and graceful shutdown will begin, allowing any remaining in-flight requests to complete.spring-doc.cn

When Kubernetes sends a SIGTERM signal to the pod, it waits for a specified time called the termination grace period (the default for which is 30 seconds). If the containers are still running after the grace period, they are sent the SIGKILL signal and forcibly removed. If the pod takes longer than 30 seconds to shut down, which could be because you have increased spring.lifecycle.timeout-per-shutdown-phase, make sure to increase the termination grace period by setting the terminationGracePeriodSeconds option in the Pod YAML.

1.3. Heroku

Heroku is another popular PaaS platform. To customize Heroku builds, you provide a Procfile, which provides the incantation required to deploy an application. Heroku assigns a port for the Java application to use and then ensures that routing to the external URI works.spring-doc.cn

You must configure your application to listen on the correct port. The following example shows the Procfile for our starter REST application:spring-doc.cn

web: java -Dserver.port=$PORT -jar target/demo-0.0.1-SNAPSHOT.jar

Spring Boot makes -D arguments available as properties accessible from a Spring Environment instance. The server.port configuration property is fed to the embedded Tomcat, Jetty, or Undertow instance, which then uses the port when it starts up. The $PORT environment variable is assigned to us by the Heroku PaaS.spring-doc.cn

This should be everything you need. The most common deployment workflow for Heroku deployments is to git push the code to production, as shown in the following example:spring-doc.cn

$ git push heroku main

Which will result in the following:spring-doc.cn

Initializing repository, done.
Counting objects: 95, done.
Delta compression using up to 8 threads.
Compressing objects: 100% (78/78), done.
Writing objects: 100% (95/95), 8.66 MiB | 606.00 KiB/s, done.
Total 95 (delta 31), reused 0 (delta 0)

-----> Java app detected
-----> Installing OpenJDK... done
-----> Installing Maven... done
-----> Installing settings.xml... done
-----> Executing: mvn -B -DskipTests=true clean install

       [INFO] Scanning for projects...
       Downloading: https://repo.spring.io/...
       Downloaded: https://repo.spring.io/... (818 B at 1.8 KB/sec)
        ....
       Downloaded: https://s3pository.heroku.com/jvm/... (152 KB at 595.3 KB/sec)
       [INFO] Installing /tmp/build_0c35a5d2-a067-4abc-a232-14b1fb7a8229/target/...
       [INFO] Installing /tmp/build_0c35a5d2-a067-4abc-a232-14b1fb7a8229/pom.xml ...
       [INFO] ------------------------------------------------------------------------
       [INFO] BUILD SUCCESS
       [INFO] ------------------------------------------------------------------------
       [INFO] Total time: 59.358s
       [INFO] Finished at: Fri Mar 07 07:28:25 UTC 2014
       [INFO] Final Memory: 20M/493M
       [INFO] ------------------------------------------------------------------------

-----> Discovering process types
       Procfile declares types -> web

-----> Compressing... done, 70.4MB
-----> Launching... done, v6
       https://agile-sierra-1405.herokuapp.com/ deployed to Heroku

To [email protected]:agile-sierra-1405.git
 * [new branch]      main -> main

Your application should now be up and running on Heroku. For more details, see Deploying Spring Boot Applications to Heroku.spring-doc.cn

1.4. OpenShift

OpenShift has many resources describing how to deploy Spring Boot applications, including:spring-doc.cn

1.5. Amazon Web Services (AWS)

Amazon Web Services offers multiple ways to install Spring Boot-based applications, either as traditional web applications (war) or as executable jar files with an embedded web server. The options include:spring-doc.cn

AWS Elastic Beanstalkspring-doc.cn
AWS Code Deployspring-doc.cn
AWS OPS Worksspring-doc.cn
AWS Cloud Formationspring-doc.cn
AWS Container Registryspring-doc.cn

Each has different features and pricing models. In this document, we describe to approach using AWS Elastic Beanstalk.spring-doc.cn

1.5.1. AWS Elastic Beanstalk

As described in the official Elastic Beanstalk Java guide, there are two main options to deploy a Java application. You can either use the “Tomcat Platform” or the “Java SE platform”.spring-doc.cn

Using the Tomcat Platform

This option applies to Spring Boot projects that produce a war file. No special configuration is required. You need only follow the official guide.spring-doc.cn

Using the Java SE Platform

This option applies to Spring Boot projects that produce a jar file and run an embedded web container. Elastic Beanstalk environments run an nginx instance on port 80 to proxy the actual application, running on port 5000. To configure it, add the following line to your application.properties file:spring-doc.cn

server.port=5000

Upload binaries instead of sources

By default, Elastic Beanstalk uploads sources and compiles them in AWS. However, it is best to upload the binaries instead. To do so, add lines similar to the following to your .elasticbeanstalk/config.yml file:spring-doc.cn

deploy:
    artifact: target/demo-0.0.1-SNAPSHOT.jar

Reduce costs by setting the environment type

By default an Elastic Beanstalk environment is load balanced. The load balancer has a significant cost. To avoid that cost, set the environment type to “Single instance”, as described in the Amazon documentation. You can also create single instance environments by using the CLI and the following command:spring-doc.cn

eb create -s

1.5.2. Summary

This is one of the easiest ways to get to AWS, but there are more things to cover, such as how to integrate Elastic Beanstalk into any CI / CD tool, use the Elastic Beanstalk Maven plugin instead of the CLI, and others. There is a blog post covering these topics more in detail.spring-doc.cn

1.6. CloudCaptain and Amazon Web Services

CloudCaptain works by turning your Spring Boot executable jar or war into a minimal VM image that can be deployed unchanged either on VirtualBox or on AWS. CloudCaptain comes with deep integration for Spring Boot and uses the information from your Spring Boot configuration file to automatically configure ports and health check URLs. CloudCaptain leverages this information both for the images it produces as well as for all the resources it provisions (instances, security groups, elastic load balancers, and so on).spring-doc.cn

Once you have created a CloudCaptain account, connected it to your AWS account, installed the latest version of the CloudCaptain Client, and ensured that the application has been built by Maven or Gradle (by using, for example, mvn clean package), you can deploy your Spring Boot application to AWS with a command similar to the following:spring-doc.cn

$ boxfuse run myapp-1.0.jar -env=prod

See the boxfuse run documentation for more options. If there is a boxfuse.conf file present in the current directory, it is considered.spring-doc.cn

By default, CloudCaptain activates a Spring profile named boxfuse on startup. If your executable jar or war contains an application-boxfuse.properties file, CloudCaptain bases its configuration on the properties it contains.

At this point, CloudCaptain creates an image for your application, uploads it, and configures and starts the necessary resources on AWS, resulting in output similar to the following example:spring-doc.cn

Fusing Image for myapp-1.0.jar ...
Image fused in 00:06.838s (53937 K) -> axelfontaine/myapp:1.0
Creating axelfontaine/myapp ...
Pushing axelfontaine/myapp:1.0 ...
Verifying axelfontaine/myapp:1.0 ...
Creating Elastic IP ...
Mapping myapp-axelfontaine.boxfuse.io to 52.28.233.167 ...
Waiting for AWS to create an AMI for axelfontaine/myapp:1.0 in eu-central-1 (this may take up to 50 seconds) ...
AMI created in 00:23.557s -> ami-d23f38cf
Creating security group boxfuse-sg_axelfontaine/myapp:1.0 ...
Launching t2.micro instance of axelfontaine/myapp:1.0 (ami-d23f38cf) in eu-central-1 ...
Instance launched in 00:30.306s -> i-92ef9f53
Waiting for AWS to boot Instance i-92ef9f53 and Payload to start at https://52.28.235.61/ ...
Payload started in 00:29.266s -> https://52.28.235.61/
Remapping Elastic IP 52.28.233.167 to i-92ef9f53 ...
Waiting 15s for AWS to complete Elastic IP Zero Downtime transition ...
Deployment completed successfully. axelfontaine/myapp:1.0 is up and running at https://myapp-axelfontaine.boxfuse.io/

Your application should now be up and running on AWS.spring-doc.cn

See the blog post on deploying Spring Boot apps on EC2 as well as the documentation for the CloudCaptain Spring Boot integration to get started with a Maven build to run the app.spring-doc.cn

1.7. Azure

This Getting Started guide walks you through deploying your Spring Boot application to either Azure Spring Cloud or Azure App Service.spring-doc.cn

1.8. Google Cloud

Google Cloud has several options that can be used to launch Spring Boot applications. The easiest to get started with is probably App Engine, but you could also find ways to run Spring Boot in a container with Container Engine or on a virtual machine with Compute Engine.spring-doc.cn

To deploy your first app to App Engine standard environment, follow this tutorial.spring-doc.cn

Alternatively, App Engine Flex requires you to create an app.yaml file to describe the resources your app requires. Normally, you put this file in src/main/appengine, and it should resemble the following file:spring-doc.cn

service: "default"

runtime: "java17"
env: "flex"

handlers:
- url: "/.*"
  script: "this field is required, but ignored"

manual_scaling:
  instances: 1

health_check:
  enable_health_check: false

env_variables:
  ENCRYPT_KEY: "your_encryption_key_here"

You can deploy the app (for example, with a Maven plugin) by adding the project ID to the build configuration, as shown in the following example:spring-doc.cn

<plugin>
    <groupId>com.google.cloud.tools</groupId>
    <artifactId>appengine-maven-plugin</artifactId>
    <version>2.4.4</version>
    <configuration>
        <project>myproject</project>
    </configuration>
</plugin>

Then deploy with mvn appengine:deploy (you need to authenticate first, otherwise the build fails).spring-doc.cn

2. Installing Spring Boot Applications

In addition to running Spring Boot applications by using java -jar directly, it is also possible to run them as systemd, init.d or Windows services.spring-doc.cn

2.1. Installation as a systemd Service

systemd is the successor of the System V init system and is now being used by many modern Linux distributions. Spring Boot applications can be launched by using systemd ‘service’ scripts.spring-doc.cn

Assuming that you have a Spring Boot application packaged as an uber jar in /var/myapp, to install it as a systemd service, create a script named myapp.service and place it in /etc/systemd/system directory. The following script offers an example:spring-doc.cn

[Unit]
Description=myapp
After=syslog.target network.target

[Service]
User=myapp
Group=myapp

Type=exec
ExecStart=/path/to/java/home/bin/java -jar /var/myapp/myapp.jar
WorkingDirectory=/var/myapp
SuccessExitStatus=143

[Install]
WantedBy=multi-user.target

Remember to change the Description, User, Group, ExecStart and WorkingDirectory fields for your application.

The ExecStart field does not declare the script action command, which means that the run command is used by default.

The user that runs the application, the PID file, and the console log file are managed by systemd itself and therefore must be configured by using appropriate fields in the ‘service’ script. Consult the service unit configuration man page for more details.spring-doc.cn

To flag the application to start automatically on system boot, use the following command:spring-doc.cn

$ systemctl enable myapp.service

Run man systemctl for more details.spring-doc.cn

2.2. Installation as an init.d Service (System V)

To use your application as init.d service, configure its build to produce a fully executable jar.spring-doc.cn

Fully executable jars work by embedding an extra script at the front of the file. Currently, some tools do not accept this format, so you may not always be able to use this technique. For example, jar -xf may silently fail to extract a jar or war that has been made fully executable. It is recommended that you make your jar or war fully executable only if you intend to execute it directly, rather than running it with java -jar or deploying it to a servlet container.

A zip64-format jar file cannot be made fully executable. Attempting to do so will result in a jar file that is reported as corrupt when executed directly or with java -jar. A standard-format jar file that contains one or more zip64-format nested jars can be fully executable.

To create a ‘fully executable’ jar with Maven, use the following plugin configuration:spring-doc.cn

<plugin>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-maven-plugin</artifactId>
    <configuration>
        <executable>true</executable>
    </configuration>
</plugin>

The following example shows the equivalent Gradle configuration:spring-doc.cn

tasks.named('bootJar') {
    launchScript()
}

It can then be symlinked to init.d to support the standard start, stop, restart, and status commands.spring-doc.cn

The default launch script that is added to a fully executable jar supports most Linux distributions and is tested on CentOS and Ubuntu. Other platforms, such as OS X and FreeBSD, require the use of a custom script. The default scripts supports the following features:spring-doc.cn

Starts the services as the user that owns the jar filespring-doc.cn
Tracks the application’s PID by using /var/run/<appname>/<appname>.pidspring-doc.cn
Writes console logs to /var/log/<appname>.logspring-doc.cn

Assuming that you have a Spring Boot application installed in /var/myapp, to install a Spring Boot application as an init.d service, create a symlink, as follows:spring-doc.cn

$ sudo ln -s /var/myapp/myapp.jar /etc/init.d/myapp

Once installed, you can start and stop the service in the usual way. For example, on a Debian-based system, you could start it with the following command:spring-doc.cn

$ service myapp start

If your application fails to start, check the log file written to /var/log/<appname>.log for errors.

You can also flag the application to start automatically by using your standard operating system tools. For example, on Debian, you could use the following command:spring-doc.cn

$ update-rc.d myapp defaults <priority>

2.2.1. Securing an init.d Service

The following is a set of guidelines on how to secure a Spring Boot application that runs as an init.d service. It is not intended to be an exhaustive list of everything that should be done to harden an application and the environment in which it runs.

When executed as root, as is the case when root is being used to start an init.d service, the default executable script runs the application as the user specified in the RUN_AS_USER environment variable. When the environment variable is not set, the user who owns the jar file is used instead. You should never run a Spring Boot application as root, so RUN_AS_USER should never be root and your application’s jar file should never be owned by root. Instead, create a specific user to run your application and set the RUN_AS_USER environment variable or use chown to make it the owner of the jar file, as shown in the following example:spring-doc.cn

$ chown bootapp:bootapp your-app.jar

In this case, the default executable script runs the application as the bootapp user.spring-doc.cn

To reduce the chances of the application’s user account being compromised, you should consider preventing it from using a login shell. For example, you can set the account’s shell to /usr/sbin/nologin.

You should also take steps to prevent the modification of your application’s jar file. Firstly, configure its permissions so that it cannot be written and can only be read or executed by its owner, as shown in the following example:spring-doc.cn

$ chmod 500 your-app.jar

Second, you should also take steps to limit the damage if your application or the account that is running it is compromised. If an attacker does gain access, they could make the jar file writable and change its contents. One way to protect against this is to make it immutable by using chattr, as shown in the following example:spring-doc.cn

$ sudo chattr +i your-app.jar

This will prevent any user, including root, from modifying the jar.spring-doc.cn

If root is used to control the application’s service and you use a .conf file to customize its startup, the .conf file is read and evaluated by the root user. It should be secured accordingly. Use chmod so that the file can only be read by the owner and use chown to make root the owner, as shown in the following example:spring-doc.cn

$ chmod 400 your-app.conf
$ sudo chown root:root your-app.conf

2.2.2. Customizing the Startup Script

The default embedded startup script written by the Maven or Gradle plugin can be customized in a number of ways. For most people, using the default script along with a few customizations is usually enough. If you find you cannot customize something that you need to, use the embeddedLaunchScript option to write your own file entirely.spring-doc.cn

Customizing the Start Script When It Is Written

It often makes sense to customize elements of the start script as it is written into the jar file. For example, init.d scripts can provide a “description”. Since you know the description up front (and it need not change), you may as well provide it when the jar is generated.spring-doc.cn

To customize written elements, use the embeddedLaunchScriptProperties option of the Spring Boot Maven plugin or the properties property of the Spring Boot Gradle plugin’s launchScript.spring-doc.cn

The following property substitutions are supported with the default script:spring-doc.cn

Name Description Gradle default Maven default

Name	Description	Gradle default	Maven default
`mode`spring-doc.cn	The script mode.spring-doc.cn	`auto`spring-doc.cn	`auto`spring-doc.cn
`initInfoProvides`spring-doc.cn	The `Provides` section of “INIT INFO”spring-doc.cn	`${task.baseName}`spring-doc.cn	`${project.artifactId}`spring-doc.cn
`initInfoRequiredStart`spring-doc.cn	`Required-Start` section of “INIT INFO”.spring-doc.cn	`$remote_fs $syslog $network`spring-doc.cn	`$remote_fs $syslog $network`spring-doc.cn
`initInfoRequiredStop`spring-doc.cn	`Required-Stop` section of “INIT INFO”.spring-doc.cn	`$remote_fs $syslog $network`spring-doc.cn	`$remote_fs $syslog $network`spring-doc.cn
`initInfoDefaultStart`spring-doc.cn	`Default-Start` section of “INIT INFO”.spring-doc.cn	`2 3 4 5`spring-doc.cn	`2 3 4 5`spring-doc.cn
`initInfoDefaultStop`spring-doc.cn	`Default-Stop` section of “INIT INFO”.spring-doc.cn	`0 1 6`spring-doc.cn	`0 1 6`spring-doc.cn
`initInfoShortDescription`spring-doc.cn	`Short-Description` section of “INIT INFO”.spring-doc.cn	Single-line version of `${project.description}` (falling back to `${task.baseName}`)spring-doc.cn	`${project.name}`spring-doc.cn
`initInfoDescription`spring-doc.cn	`Description` section of “INIT INFO”.spring-doc.cn	`${project.description}` (falling back to `${task.baseName}`)spring-doc.cn	`${project.description}` (falling back to `${project.name}`)spring-doc.cn
`initInfoChkconfig`spring-doc.cn	`chkconfig` section of “INIT INFO”spring-doc.cn	`2345 99 01`spring-doc.cn	`2345 99 01`spring-doc.cn
`confFolder`spring-doc.cn	The default value for `CONF_FOLDER`spring-doc.cn	Folder containing the jarspring-doc.cn	Folder containing the jarspring-doc.cn
`inlinedConfScript`spring-doc.cn	Reference to a file script that should be inlined in the default launch script. This can be used to set environmental variables such as `JAVA_OPTS` before any external config files are loadedspring-doc.cn
`logFolder`spring-doc.cn	Default value for `LOG_FOLDER`. Only valid for an `init.d` servicespring-doc.cn
`logFilename`spring-doc.cn	Default value for `LOG_FILENAME`. Only valid for an `init.d` servicespring-doc.cn
`pidFolder`spring-doc.cn	Default value for `PID_FOLDER`. Only valid for an `init.d` servicespring-doc.cn
`pidFilename`spring-doc.cn	Default value for the name of the PID file in `PID_FOLDER`. Only valid for an `init.d` servicespring-doc.cn
`useStartStopDaemon`spring-doc.cn	Whether the `start-stop-daemon` command, when it is available, should be used to control the processspring-doc.cn	`true`spring-doc.cn	`true`spring-doc.cn
`stopWaitTime`spring-doc.cn	Default value for `STOP_WAIT_TIME` in seconds. Only valid for an `init.d` servicespring-doc.cn	60spring-doc.cn	60spring-doc.cn

modespring-doc.cn

The script mode.spring-doc.cn

autospring-doc.cn

initInfoProvidesspring-doc.cn

The Provides section of “INIT INFO”spring-doc.cn

${task.baseName}spring-doc.cn

${project.artifactId}spring-doc.cn

initInfoRequiredStartspring-doc.cn

Required-Start section of “INIT INFO”.spring-doc.cn

$remote_fs $syslog $networkspring-doc.cn

initInfoRequiredStopspring-doc.cn

Required-Stop section of “INIT INFO”.spring-doc.cn

$remote_fs $syslog $networkspring-doc.cn

initInfoDefaultStartspring-doc.cn

Default-Start section of “INIT INFO”.spring-doc.cn

2 3 4 5spring-doc.cn

initInfoDefaultStopspring-doc.cn

Default-Stop section of “INIT INFO”.spring-doc.cn

0 1 6spring-doc.cn

initInfoShortDescriptionspring-doc.cn

Short-Description section of “INIT INFO”.spring-doc.cn

Single-line version of ${project.description} (falling back to ${task.baseName})spring-doc.cn

${project.name}spring-doc.cn

initInfoDescriptionspring-doc.cn

Description section of “INIT INFO”.spring-doc.cn

${project.description} (falling back to ${task.baseName})spring-doc.cn

${project.description} (falling back to ${project.name})spring-doc.cn

initInfoChkconfigspring-doc.cn

chkconfig section of “INIT INFO”spring-doc.cn

2345 99 01spring-doc.cn

confFolderspring-doc.cn

The default value for CONF_FOLDERspring-doc.cn

Folder containing the jarspring-doc.cn

inlinedConfScriptspring-doc.cn

Reference to a file script that should be inlined in the default launch script. This can be used to set environmental variables such as JAVA_OPTS before any external config files are loadedspring-doc.cn

logFolderspring-doc.cn

Default value for LOG_FOLDER. Only valid for an init.d servicespring-doc.cn

logFilenamespring-doc.cn

Default value for LOG_FILENAME. Only valid for an init.d servicespring-doc.cn

pidFolderspring-doc.cn

Default value for PID_FOLDER. Only valid for an init.d servicespring-doc.cn

pidFilenamespring-doc.cn

Default value for the name of the PID file in PID_FOLDER. Only valid for an init.d servicespring-doc.cn

useStartStopDaemonspring-doc.cn

Whether the start-stop-daemon command, when it is available, should be used to control the processspring-doc.cn

truespring-doc.cn

stopWaitTimespring-doc.cn

Default value for STOP_WAIT_TIME in seconds. Only valid for an init.d servicespring-doc.cn

60spring-doc.cn

Customizing a Script When It Runs

For items of the script that need to be customized after the jar has been written, you can use environment variables or a config file.spring-doc.cn

The following environment properties are supported with the default script:spring-doc.cn

Variable Description

Variable	Description
`MODE`spring-doc.cn	The “mode” of operation. The default depends on the way the jar was built but is usually `auto` (meaning it tries to guess if it is an init script by checking if it is a symlink in a directory called `init.d`). You can explicitly set it to `service` so that the `stop\|start\|status\|restart` commands work or to `run` if you want to run the script in the foreground.spring-doc.cn
`RUN_AS_USER`spring-doc.cn	The user that will be used to run the application. When not set, the user that owns the jar file will be used.spring-doc.cn
`USE_START_STOP_DAEMON`spring-doc.cn	Whether the `start-stop-daemon` command, when it is available, should be used to control the process. Defaults to `true`.spring-doc.cn
`PID_FOLDER`spring-doc.cn	The root name of the pid folder (`/var/run` by default).spring-doc.cn
`LOG_FOLDER`spring-doc.cn	The name of the folder in which to put log files (`/var/log` by default).spring-doc.cn
`CONF_FOLDER`spring-doc.cn	The name of the folder from which to read .conf files (same folder as jar-file by default).spring-doc.cn
`LOG_FILENAME`spring-doc.cn	The name of the log file in the `LOG_FOLDER` (`<appname>.log` by default).spring-doc.cn
`APP_NAME`spring-doc.cn	The name of the app. If the jar is run from a symlink, the script guesses the app name. If it is not a symlink or you want to explicitly set the app name, this can be useful.spring-doc.cn
`RUN_ARGS`spring-doc.cn	The arguments to pass to the program (the Spring Boot app).spring-doc.cn
`JAVA_HOME`spring-doc.cn	The location of the `java` executable is discovered by using the `PATH` by default, but you can set it explicitly if there is an executable file at `$JAVA_HOME/bin/java`.spring-doc.cn
`JAVA_OPTS`spring-doc.cn	Options that are passed to the JVM when it is launched.spring-doc.cn
`JARFILE`spring-doc.cn	The explicit location of the jar file, in case the script is being used to launch a jar that it is not actually embedded.spring-doc.cn
`DEBUG`spring-doc.cn	If not empty, sets the `-x` flag on the shell process, allowing you to see the logic in the script.spring-doc.cn
`STOP_WAIT_TIME`spring-doc.cn	The time in seconds to wait when stopping the application before forcing a shutdown (`60` by default).spring-doc.cn

MODEspring-doc.cn

The “mode” of operation. The default depends on the way the jar was built but is usually auto (meaning it tries to guess if it is an init script by checking if it is a symlink in a directory called init.d). You can explicitly set it to service so that the stop|start|status|restart commands work or to run if you want to run the script in the foreground.spring-doc.cn

RUN_AS_USERspring-doc.cn

The user that will be used to run the application. When not set, the user that owns the jar file will be used.spring-doc.cn

USE_START_STOP_DAEMONspring-doc.cn

Whether the start-stop-daemon command, when it is available, should be used to control the process. Defaults to true.spring-doc.cn

PID_FOLDERspring-doc.cn

The root name of the pid folder (/var/run by default).spring-doc.cn

LOG_FOLDERspring-doc.cn

The name of the folder in which to put log files (/var/log by default).spring-doc.cn

CONF_FOLDERspring-doc.cn

The name of the folder from which to read .conf files (same folder as jar-file by default).spring-doc.cn

LOG_FILENAMEspring-doc.cn

The name of the log file in the LOG_FOLDER (<appname>.log by default).spring-doc.cn

APP_NAMEspring-doc.cn

The name of the app. If the jar is run from a symlink, the script guesses the app name. If it is not a symlink or you want to explicitly set the app name, this can be useful.spring-doc.cn

RUN_ARGSspring-doc.cn

The arguments to pass to the program (the Spring Boot app).spring-doc.cn

JAVA_HOMEspring-doc.cn

The location of the java executable is discovered by using the PATH by default, but you can set it explicitly if there is an executable file at $JAVA_HOME/bin/java.spring-doc.cn

JAVA_OPTSspring-doc.cn

Options that are passed to the JVM when it is launched.spring-doc.cn

JARFILEspring-doc.cn

The explicit location of the jar file, in case the script is being used to launch a jar that it is not actually embedded.spring-doc.cn

DEBUGspring-doc.cn

If not empty, sets the -x flag on the shell process, allowing you to see the logic in the script.spring-doc.cn

STOP_WAIT_TIMEspring-doc.cn

The time in seconds to wait when stopping the application before forcing a shutdown (60 by default).spring-doc.cn

The PID_FOLDER, LOG_FOLDER, and LOG_FILENAME variables are only valid for an init.d service. For systemd, the equivalent customizations are made by using the ‘service’ script. See the service unit configuration man page for more details.

Using a Conf Gile

With the exception of JARFILE and APP_NAME, the settings listed in the preceding section can be configured by using a .conf file. The file is expected to be next to the jar file and have the same name but suffixed with .conf rather than .jar. For example, a jar named /var/myapp/myapp.jar uses the configuration file named /var/myapp/myapp.conf, as shown in the following example:spring-doc.cn

myapp.conf

JAVA_OPTS=-Xmx1024M
LOG_FOLDER=/custom/log/folder

If you do not like having the config file next to the jar file, you can set a CONF_FOLDER environment variable to customize the location of the config file.

To learn about securing this file appropriately, see the guidelines for securing an init.d service.spring-doc.cn

2.3. Microsoft Windows Services

A Spring Boot application can be started as a Windows service by using winsw.spring-doc.cn

A (separately maintained sample) describes step-by-step how you can create a Windows service for your Spring Boot application.spring-doc.cn

3. Efficient deployments

3.1. Unpacking the Executable JAR

If you are running your application from a container, you can use an executable jar, but it is also often an advantage to explode it and run it in a different way. Certain PaaS implementations may also choose to unpack archives before they run. For example, Cloud Foundry operates this way. One way to run an unpacked archive is by starting the appropriate launcher, as follows:spring-doc.cn

$ jar -xf myapp.jar
$ java org.springframework.boot.loader.launch.JarLauncher

This is actually slightly faster on startup (depending on the size of the jar) than running from an unexploded archive. After startup, you should not expect any differences.spring-doc.cn

Once you have unpacked the jar file, you can also get an extra boost to startup time by running the app with its "natural" main method instead of the JarLauncher. For example:spring-doc.cn

$ jar -xf myapp.jar
$ java -cp "BOOT-INF/classes:BOOT-INF/lib/*" com.example.MyApplication

Using the JarLauncher over the application’s main method has the added benefit of a predictable classpath order. The jar contains a classpath.idx file which is used by the JarLauncher when constructing the classpath.

3.2. Using Ahead-of-time Processing With the JVM

It’s beneficial for the startup time to run your application using the AOT generated initialization code. First, you need to ensure that the jar you are building includes AOT generated code.spring-doc.cn

For Maven, this means that you should build with -Pnative to activate the native profile:spring-doc.cn

$ mvn -Pnative package

For Gradle, you need to ensure that your build includes the org.springframework.boot.aot plugin.spring-doc.cn

When the JAR has been built, run it with spring.aot.enabled system property set to true. For example:spring-doc.cn

$ java -Dspring.aot.enabled=true -jar myapplication.jar

........ Starting AOT-processed MyApplication ...

Beware that using the ahead-of-time processing has drawbacks. It implies the following restrictions:spring-doc.cn

The classpath is fixed and fully defined at build timespring-doc.cn
The beans defined in your application cannot change at runtime, meaning:spring-doc.cn
- The Spring @Profile annotation and profile-specific configuration have limitations.spring-doc.cn
- Properties that change if a bean is created are not supported (for example, @ConditionalOnProperty and .enable properties).spring-doc.cn

To learn more about ahead-of-time processing, please see the Understanding Spring Ahead-of-Time Processing section.spring-doc.cn

3.3. Checkpoint and Restore With the JVM

Coordinated Restore at Checkpoint (CRaC) is an OpenJDK project that defines a new Java API to allow you to checkpoint and restore an application on the HotSpot JVM. It is based on CRIU, a project that implements checkpoint/restore functionality on Linux.spring-doc.cn

The principle is the following: you start your application almost as usual but with a CRaC enabled version of the JDK like Bellsoft Liberica JDK with CRaC or Azul Zulu JDK with CRaC. Then at some point, potentially after some workloads that will warm up your JVM by executing all common code paths, you trigger a checkpoint using an API call, a jcmd command, an HTTP endpoint, or a different mechanism.spring-doc.cn

A memory representation of the running JVM, including its warmness, is then serialized to disk, allowing a fast restoration at a later point, potentially on another machine with a similar operating system and CPU architecture. The restored process retains all the capabilities of the HotSpot JVM, including further JIT optimizations at runtime.spring-doc.cn

Based on the foundations provided by Spring Framework, Spring Boot provides support for checkpointing and restoring your application, and manages out-of-the-box the lifecycle of resources such as socket, files and thread pools on a limited scope. Additional lifecycle management is expected for other dependencies and potentially for the application code dealing with such resources.spring-doc.cn

You can find more details about the two modes supported ("on demand checkpoint/restore of a running application" and "automatic checkpoint/restore at startup"), how to enable checkpoint and restore support and some guidelines in the Spring Framework JVM Checkpoint Restore support documentation.spring-doc.cn

4. What to Read Next

See the Cloud Foundry, Heroku, OpenShift, and Boxfuse web sites for more information about the kinds of features that a PaaS can offer. These are just four of the most popular Java PaaS providers. Since Spring Boot is so amenable to cloud-based deployment, you can freely consider other providers as well.spring-doc.cn

The next section goes on to cover the GraalVM Native Images, or you can jump ahead to read about the Spring Boot CLI or our build tool plugins.spring-doc.cn