Help Center/CodeArts Deploy/User Guide/Creating and Deploying an Application with a Blank Template/Configuring Application Deployment Actions/Configuring Deployment Actions for Starting or Stopping a Service/Starting or Stopping Spring Boot
Updated on 2026-01-21 GMT+08:00
View PDF
Share

Starting or Stopping Spring Boot

This action aims to start or stop Spring Boot in a specified path on the target host in an environment.

Configuring Deployment Actions

  1. Create an application by referring to Creating an Application.
  2. On the Deployment Actions page, add this deployment action based on the service scenario.
  3. Configure the action using the parameters described in the table below.

    Table 1 Parameters

    Parameter

    Description

    Action Name

    Custom action name. Enter 1 to 128 characters. Do not start or end with a space. Use letters, digits, spaces, and these special characters: -_,;:./()

    Environment

    Deployment object. Select an environment whose resource type is host cluster.

    Operation

    Start and Stop are available.

    Absolute Path

    Absolute path of the Spring Boot service.

    System Variables

    • Optional.
    • Java running parameters. JVM variables are used. The commonly used parameter is -D.
    • The -XX and -X parameters are used to set the memory and GC parameters, respectively. The parameter settings may vary according to JVMs.
    • The -D and -X parameters are followed by Java. When starting the service, you can set the memory required for service running.
    NOTE:

    The common parameter format is -Dfile.encoding=UTF-8 -Xms256m -Xmx512m.

    Command Parameters

    • Optional.
    • Spring Boot running parameters, that is, application parameters.
    • If you choose to start the service, you can use the -- parameter to set the listening port of the Spring Boot service.
    NOTE:

    The common parameter format is --server.port=9000 --spring.profiles.active=prod.

    Waiting Time

    Time for waiting for the service to start. If you choose to start the service, the system checks the process during the startup to determine whether the service is started successfully. You can adjust the time based on the actual time required for starting the service. If the time is improper, the detection fails.

    Action Control

    Whether to enable the settings.

    • Keep running on failure: Continue the task even if this action fails.
    • Execute this action with the sudo permission: Use the sudo permission to deploy this action.

Helpful Links

If you encounter any problem during deployment, see Starting or Stopping Spring Boot.

Parent Topic: Configuring Deployment Actions for Starting or Stopping a Service