云部署
Spring Boot 的可执行 JAR 适用于大多数流行的云 PaaS(平台即服务)提供商。这些提供商通常要求您“自带容器”。它们管理应用程序进程(而不是专门针对 Java 应用程序),因此它们需要一个中间层来将您的应用程序适配到云对正在运行的进程的理解。
两个流行的云提供商 Heroku 和 Cloud Foundry 使用“构建包”方法。构建包将您部署的代码包装在启动应用程序所需的一切中。它可能是 JDK 和对 java
的调用、嵌入式 Web 服务器或功能齐全的应用程序服务器。构建包是可插拔的,但理想情况下,您应该能够尽可能少地对其进行自定义。这减少了不受您控制的功能的占用空间。它最大程度地减少了开发和生产环境之间的差异。
理想情况下,您的应用程序(如 Spring Boot 可执行 JAR)包含其运行所需的一切。
在本节中,我们将介绍使“入门”部分中开发的应用程序在云中启动并运行所需的操作。
Cloud Foundry
Cloud Foundry 提供默认构建包,如果未指定其他构建包,则这些构建包会发挥作用。Cloud Foundry Java 构建包 对 Spring 应用程序(包括 Spring Boot)提供了极佳的支持。您可以部署独立的可执行 JAR 应用程序以及传统的 .war
打包应用程序。
构建完应用程序(例如,使用 mvn clean package
)并安装了 cf
命令行工具后,可以使用 cf push
命令部署应用程序,并将路径替换为您编译的 .jar
。在推送应用程序之前,请确保已使用 cf
命令行客户端登录。以下行显示了使用 cf push
命令部署应用程序
$ cf push acloudyspringtime -p target/demo-0.0.1-SNAPSHOT.jar
在前面的示例中,我们将 acloudyspringtime 替换为您为 cf 提供的应用程序名称的值。
|
请参阅cf push
文档以获取更多选项。如果在同一目录中存在 Cloud Foundry manifest.yml
文件,则会考虑该文件。
此时,cf
开始上传您的应用程序,并生成类似于以下示例的输出
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
恭喜!应用程序现已上线!
应用程序上线后,您可以使用 cf apps
命令验证已部署应用程序的状态,如下例所示
$ cf apps
Getting applications in ...
OK
name requested state instances memory disk urls
...
acloudyspringtime started 1/1 512M 1G acloudyspringtime.cfapps.io
...
Cloud Foundry 确认您的应用程序已部署后,您应该能够在提供的 URI 上找到该应用程序。在前面的示例中,您可以在 https://acloudyspringtime.cfapps.io/
找到它。
绑定到服务
默认情况下,有关正在运行的应用程序以及服务连接信息的相关元数据将作为环境变量(例如:$VCAP_SERVICES
)公开给应用程序。此架构决策是由于 Cloud Foundry 的多语言(任何语言和平台都可作为构建包支持)特性。进程范围的环境变量与语言无关。
环境变量并不总是最简单的 API,因此 Spring Boot 会自动提取它们并将数据展平为属性,这些属性可以通过 Spring 的 Environment
抽象进行访问,如下例所示
-
Java
-
Kotlin
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");
}
// ...
}
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")
}
// ...
}
所有 Cloud Foundry 属性都以 vcap
为前缀。您可以使用 vcap
属性访问应用程序信息(例如应用程序的公共 URL)和服务信息(例如数据库凭据)。请参阅CloudFoundryVcapEnvironmentPostProcessor
API 文档以获取完整详细信息。
Java CFEnv 项目更适合于配置 DataSource 等任务。 |
Kubernetes
Spring Boot 通过检查环境中的 "*_SERVICE_HOST"
和 "*_SERVICE_PORT"
变量来自动检测 Kubernetes 部署环境。您可以使用 spring.main.cloud-platform
配置属性覆盖此检测。
Spring Boot 可帮助您管理应用程序的状态并使用HTTP Kubernetes 探针(使用 Actuator)导出该状态。
Kubernetes 容器生命周期
当 Kubernetes 删除应用程序实例时,关闭过程会同时涉及多个子系统:关闭挂钩、注销服务、从负载均衡器中移除实例……由于此关闭处理是并行进行的(并且由于分布式系统的性质),因此存在一个窗口,在此窗口期间流量可以路由到也已开始关闭处理的 Pod。
您可以在 preStop 处理程序中配置睡眠执行,以避免将请求路由到已开始关闭的 Pod。此睡眠时间应足够长,以使新的请求停止路由到 Pod,并且其持续时间会因部署而异。可以通过使用 Pod 配置文件中的 PodSpec 来配置 preStop 处理程序,如下所示
spec:
containers:
- name: "example-container"
image: "example-image"
lifecycle:
preStop:
exec:
command: ["sh", "-c", "sleep 10"]
pre-stop 挂钩完成后,将向容器发送 SIGTERM 信号,并且将开始优雅关闭,从而允许任何剩余的进行中请求完成。
当 Kubernetes 向 Pod 发送 SIGTERM 信号时,它会等待指定的时间,称为终止宽限期(默认为 30 秒)。如果容器在宽限期后仍在运行,则会向它们发送 SIGKILL 信号并强制将其移除。如果 Pod 关闭时间超过 30 秒,这可能是因为您已增加 spring.lifecycle.timeout-per-shutdown-phase ,请确保通过在 Pod YAML 中设置 terminationGracePeriodSeconds 选项来增加终止宽限期。 |
Heroku
Heroku 是另一个流行的 PaaS 平台。要自定义 Heroku 构建,您可以提供一个 Procfile
,其中提供了部署应用程序所需的咒语。Heroku 为 Java 应用程序分配一个 port
以供使用,然后确保路由到外部 URI 可行。
您必须将应用程序配置为侦听正确的端口。以下示例显示了我们的入门 REST 应用程序的 Procfile
web: java -Dserver.port=$PORT -jar target/demo-0.0.1-SNAPSHOT.jar
Spring Boot 使 -D
参数作为属性可用,这些属性可从 Spring Environment
实例访问。server.port
配置属性被馈送到嵌入式 Tomcat、Jetty 或 Undertow 实例,然后该实例在启动时使用该端口。$PORT
环境变量由 Heroku PaaS 分配给我们。
这应该是您需要的一切。Heroku 部署最常见的部署工作流是将代码 git push
到生产环境,如下例所示
$ git push heroku main
这将导致以下结果
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
您的应用程序现在应该在 Heroku 上运行。有关更多详细信息,请参阅将 Spring Boot 应用程序部署到 Heroku。
OpenShift
OpenShift 提供了许多有关如何部署 Spring Boot 应用程序的资源,包括
Amazon Web Services (AWS)
Amazon Web Services 提供多种安装基于 Spring Boot 的应用程序的方法,无论是作为传统的 Web 应用程序 (war) 还是作为具有嵌入式 Web 服务器的可执行 jar 文件。选项包括
-
AWS Elastic Beanstalk
-
AWS Code Deploy
-
AWS OPS Works
-
AWS Cloud Formation
-
AWS Container Registry
每个选项都具有不同的功能和定价模型。在本文档中,我们介绍了使用 AWS Elastic Beanstalk 的方法。
AWS Elastic Beanstalk
如官方Elastic Beanstalk Java 指南中所述,部署 Java 应用程序主要有两种方法。您可以使用“Tomcat 平台”或“Java SE 平台”。
使用 Java SE 平台
此选项适用于生成 jar 文件并运行嵌入式 Web 容器的 Spring Boot 项目。Elastic Beanstalk 环境在端口 80 上运行 nginx 实例以代理实际应用程序(在端口 5000 上运行)。要对其进行配置,请将以下行添加到您的 application.properties
文件中
-
属性
-
YAML
server.port=5000
server:
port: 5000
上传二进制文件而不是源代码
默认情况下,Elastic Beanstalk 会上传源代码并在 AWS 中编译它们。但是,最好上传二进制文件。为此,请将类似于以下行的行添加到您的
|
通过设置环境类型来降低成本
默认情况下,Elastic Beanstalk 环境是负载均衡的。负载均衡器成本很高。要避免此成本,请将环境类型设置为“单个实例”,如Amazon 文档中所述。您也可以使用 CLI 和以下命令创建单个实例环境
|
总结
这是进入 AWS 的最简单方法之一,但还有更多内容需要介绍,例如如何将 Elastic Beanstalk 集成到任何 CI/CD 工具中,使用 Elastic Beanstalk Maven 插件而不是 CLI,以及其他内容。有一篇博文更详细地介绍了这些主题。
CloudCaptain 和 Amazon Web Services
CloudCaptain 的工作原理是将您的 Spring Boot 可执行 jar 或 war 转换为可在 VirtualBox 或 AWS 上不变地部署的最小 VM 映像。CloudCaptain 与 Spring Boot 深度集成,并使用来自 Spring Boot 配置文件的信息来自动配置端口和运行状况检查 URL。CloudCaptain 利用此信息来生成其生成的映像以及它预配的所有资源(实例、安全组、弹性负载均衡器等)。
创建CloudCaptain 帐户、将其连接到您的 AWS 帐户、安装最新版本的 CloudCaptain 客户端并确保应用程序已由 Maven 或 Gradle 构建(例如,使用 mvn clean package
)后,您可以使用类似于以下的命令将 Spring Boot 应用程序部署到 AWS
$ boxfuse run myapp-1.0.jar -env=prod
请参阅boxfuse run
文档以获取更多选项。如果当前目录中存在boxfuse.conf
文件,则会考虑该文件。
默认情况下,CloudCaptain 在启动时激活名为 boxfuse 的 Spring 配置文件。如果您的可执行 jar 或 war 包含application-boxfuse.properties 文件,则 CloudCaptain 会根据其中包含的属性进行配置。 |
此时,CloudCaptain 为您的应用程序创建映像,上传它,并在 AWS 上配置和启动必要的资源,从而生成类似于以下示例的输出
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/
您的应用程序现在应该在 AWS 上运行。
请参阅有关在 EC2 上部署 Spring Boot 应用程序的博文以及CloudCaptain Spring Boot 集成文档,以开始使用 Maven 构建来运行应用程序。
Azure
本入门指南将引导您将 Spring Boot 应用程序部署到Azure Spring Cloud或Azure App Service。
Google Cloud
Google Cloud 提供了多个选项可用于启动 Spring Boot 应用程序。最容易上手的可能是 App Engine,但您也可以找到使用 Container Engine 在容器中运行 Spring Boot 或使用 Compute Engine 在虚拟机上运行 Spring Boot 的方法。
要将您的第一个应用程序部署到 App Engine 标准环境,请遵循本教程。
或者,App Engine Flex 需要您创建一个app.yaml
文件来描述您的应用程序所需的资源。通常,您将此文件放在src/main/appengine
中,它应该类似于以下文件
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"
您可以(例如,使用 Maven 插件)通过将项目 ID 添加到构建配置中来部署应用程序,如下例所示
<plugin>
<groupId>com.google.cloud.tools</groupId>
<artifactId>appengine-maven-plugin</artifactId>
<version>2.4.4</version>
<configuration>
<project>myproject</project>
</configuration>
</plugin>
然后使用mvn appengine:deploy
进行部署(您需要先进行身份验证,否则构建将失败)。