JBoss EAP for OpenShift Container Platform 入门
使用 Red Hat JBoss Enterprise Application Platform for OpenShift 进行开发的指南
摘要
提供有关 JBoss EAP 文档的反馈
要报告错误或改进文档,请登录到 Red Hat JIRA 帐户并提交问题。如果您没有 Red Hat Jira 帐户,则会提示您创建一个帐户。
流程
- 单击以下链接 以创建 ticket。
- 请包含 文档 URL、章节编号 并描述问题。
- 在 Summary 中输入问题的简短描述。
- 在 Description 中提供问题或功能增强的详细描述。包括一个指向文档中问题的 URL。
- 点 Submit 创建问题,并将问题路由到适当的文档团队。
使开源包含更多
红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。我们从这四个术语开始:master、slave、黑名单和白名单。由于此项工作十分艰巨,这些更改将在即将推出的几个发行版本中逐步实施。有关更多详情,请参阅我们的首席技术官 Chris Wright 提供的消息。
第 1 章 简介
1.1. 什么是红帽 JBoss 企业应用平台(JBoss EAP)?
Red Hat JBoss Enterprise Application Platform 7.4(JBoss EAP)是一个基于开放标准构建的中间件平台,符合 Jakarta EE 8 规格。它为高可用性集群、消息传递和分布式缓存等功能提供预配置选项。它包含一个模块化结构,允许您仅在需要时启用服务,从而提高了启动速度。
基于 Web 的管理控制台和管理命令行界面(CLI)无需编辑 XML 配置文件,添加脚本和自动化任务的能力。此外,JBoss EAP 包括 API 和开发框架,使您能够快速开发、部署和运行安全、可扩展的 Jakarta EE 应用程序。JBoss EAP 7.4 是 Jakarta EE 8 兼容实施,适用于 Web Profile 和 Full Platform 规格。
1.2. 如何在 OpenShift 上使用 JBoss EAP?
红帽为 JBoss EAP 提供了一个容器化镜像,设计为与 OpenShift 搭配使用。通过使用此镜像,开发人员可以快速轻松地构建、扩展和测试部署在混合环境中的应用程序。
1.3. 比较:用于 OpenShift 的 JBoss EAP 和 JBoss EAP
在比较 JBoss EAP 产品与 OpenShift 镜像的 JBoss EAP 时,有一些显著区别。以表介绍了 JBoss EAP for OpenShift 当前版本与 JBoss EAP 的比较
表 1.1. 用于 OpenShift 的 JBoss EAP 和 JBoss EAP 之间的区别
JBoss EAP 功能 | OpenShift JBoss EAP 中的状态 | 描述 |
---|---|---|
JBoss EAP 管理控制台 | 不包括 | JBoss EAP 管理控制台没有包括在 JBoss EAP for OpenShift 的这个版本中。 |
JBoss EAP 管理 CLI | 不建议 | 不建议将 JBoss EAP 管理 CLI 与在容器化环境中运行的 JBoss EAP 一起使用。在容器重启时,使用管理 CLI 进行的任何配置更改都会丢失。可以从一个 pod 内访问管理 CLI,以进行故障排除。 |
受管域 | 不支持 | 虽然不支持 JBoss EAP 受管域,但应用程序的创建和分发是由 OpenShift 中的容器管理的。 |
默认 root 页面 | Disabled |
默认的 root 页面已被禁用,但您可以将自己的应用程序部署在 root 上下文中作为 |
远程消息 | 支持 | 支持 Red Hat AMQ 进行 pod 和远程消息传递。ActiveMQ Artemis 仅支持具有 JBoss EAP 实例的单一 pod 内消息传递,并且仅在缺少红帽 AMQ 时启用。 |
事务恢复 | 部分支持 | EAP 操作器是 OpenShift 4 中唯一进行了测试并被支持的事务选项。有关使用 EAP 操作器恢复事务的更多信息,请参阅 EAP Operator for Safe transaction Recovery。 一些环境不被支持。有关不支持的场景的更多信息,请参阅不支持的事务恢复方案。 |
嵌入式消息传递代理 | 已弃用 | 在 OpenShift 容器中使用嵌入的消息传递代理已被弃用。以后的发行版本中会删除对嵌入式代理的支持。 如果容器被配置为使用嵌入的消息传递代理,并且没有配置远程代理,则会记录警告。
如果容器配置不包括消息传递目的地,请将 |
1.4. 版本兼容性和支持
OpenShift 的 JBoss EAP 为 OpenJDK 8 和 OpenJDK 11 提供镜像。
每个镜像有两个变体:S2I 构建器镜像和一个运行时镜像。S2I 构建器镜像包含 S2I 构建期间需要的完整 JBoss EAP 服务器。运行时镜像包含运行 JBoss EAP 但不包含服务器所需的依赖项。服务器在链的构建期间安装在运行时镜像中。
以下修改应用于 OpenShift JBoss EAP 7.4 中的镜像。
- 删除默认驱动程序和模块。
- 删除 MySQL 和 PostgreSQL 的模板。您可以使用自定义层置备这些功能。
- Hawkular 代理在这些镜像中没有激活。如果配置,它将被忽略。
-
默认情况下,数据源 (
ExampleDS
) 在容器启动时不再添加。如果您需要默认数据源,请使用环境变量ENABLE_GENERATE_DEFAULT_DATASOURCE
和值true
(ENABLE_GENERATE_DEFAULT_DATASOURCE=true
)包含它。
以下发现机制协议已弃用,并被其他协议替代:
-
openshift.DNS_PING
协议已弃用,并使用dns.DNS_PING
协议替换。如果您在自定义 standalone-openshift.xml
文件中引用openshift.DNS_PING
协议,请将协议替换为dns.DNS_PING
协议。 -
openshift.KUBE_PING
发现机制协议已弃用,并被kubernetes.KUBE_PING
协议替代。
OpenJDK 镜像支持的构架
OpenJDK 镜像支持多种架构。下表总结了此信息:
- OpenJDK 镜像和架构
JDK (OS) | 支持的构架 | 红帽生态系统目录 |
OpenJDK8 (RHEL 7) | x86_64 | |
OpenJDK11 (RHEL 8) | x86_64、IBM Z 和 IBM Power Systems |
JBoss EAP for OpenShift 会被频繁更新。因此,务必要了解哪个版本的镜像与哪些 OpenShift 版本兼容。
1.4.1. OpenShift 4.x 支持
OpenShift 4.1 中的更改会影响 Jolokia 的访问,OpenShift 4.x web 控制台中不再可用 Open Java 控制台。
在以前的 OpenShift 版本中,某些 kube-apiserver 代理请求被验证并传递给集群。这个行为现在被视为不安全,因此不再支持以这种方式访问 Jolokia。
由于 OpenShift 控制台的代码库更改,Open Java 控制台的链接不再可用。
1.4.2. IBM Z 支持
镜像中没有包括 libartemis-native
的 s390x 变体。因此,任何与 AIO 相关的设置都不会考虑。
-
journal-type
:将journal-type
设为ASYNCIO
没有作用。此属性的值可在运行时默认为NIO
。 -
journal-max-io
:此属性无效。 -
journal-store-enable-async-io
:此属性无效。
1.4.3. 在 OpenShift 上从 JBoss EAP 7.1 升级到 JBoss EAP 7.4
在 OpenShift 上安装了 JBoss EAP 7.1 的文件 standalone-openshift.xml
文件与 JBoss EAP 7.4 及之后的版本不兼容。在为 OpenShift 启动 JBoss EAP 7.4 或更高版本之前,您必须修改 JBoss EAP 7.1 安装的 standalone-openshift.xml
文件。
1.5. 部署选项
您可以使用以下选项之一在 OpenShift 上部署 JBoss EAP Java 应用程序:
- JBoss EAP for OpenShift 模板。
EAP 操作器(特定于 JBoss EAP 的控制器)扩展 OpenShift API 以便代表 OpenShift 用户创建、配置和管理复杂有状态应用的实例。
注意只有在 OpenShift 4 及更新的版本中才支持 EAP 操作器。
其他资源
- 如需有关 JBoss EAP for OpenShift 模板的更多信息,请参阅 Git Hub 上的 jboss-eap-openshift-templates。
- 如需有关 EAP 操作器的更多信息,请参阅 EAP Operator for Automating Application Deployment on OpenShift。
第 2 章 在 JBoss EAP for OpenShift 镜像中构建并运行 Java 应用程序
以下工作流演示使用 Source-to-Image(S2I)流程在 OpenShift 镜像的 JBoss EAP 上构建和运行 Java 应用。
例如,此流程中使用 kitchensink
Quickstart。它展示了一个支持 Jakarta EE Web 的数据库应用程序,使用 Jakarta Server risk、Jakarta Contexts、Jakarta Enterprise Beans、Jakarta Persistence 和 Jakarta Bean Validation.如需更多信息,请参阅 JBoss EAP 7 附带的 kitchensink
Quickstart。
2.1. 先决条件
已安装并运行 OpenShift 实例。如需有关安装和配置 OpenShift 实例的更多信息,请参阅 OpenShift Container Platform 快速入门指南。
2.2. 为应用程序部署准备 OpenShift
-
使用
oc login
命令登录到您的 OpenShift 实例。 在 OpenShift 中创建一个新项目。
通过项目,一组用户可以独立于其他组来组织和管理内容。您可以使用以下命令在 OpenShift 中创建项目。
$ oc new-project <project_name>
例如,对于
kitchensink
quickstart,使用以下命令创建名为eap-demo
的新项目:$ oc new-project eap-demo
可选 :创建密钥存储和机密。
注意如果您使用 OpenShift 项目中任何启用了 HTTPS 的功能,则需要创建密钥存储和 secret。例如,如果您使用
eap74-https-s2i
模板,您必须创建一个密钥存储和 secret。kitchensink
quickstart 的这一工作流演示不使用 HTTPS 模板,因此不需要密钥存储和 secret。创建密钥存储。
警告以下命令会生成自签名证书,但对于生产环境,红帽建议您使用从验证证书颁发机构(CA)处购买的 SSL 证书进行 SSL 加密的连接(HTTPS)。
您可以使用 Java
keytool
命令生成密钥存储:$ keytool -genkey -keyalg RSA -alias <alias_name> -keystore <keystore_filename.jks> -validity 360 -keysize 2048
例如,对于
kitchensink
Quickstart,请使用以下命令生成密钥存储:$ keytool -genkey -keyalg RSA -alias eapdemo-selfsigned -keystore keystore.jks -validity 360 -keysize 2048
从密钥存储创建一个 secret。
使用以下命令,从之前创建的密钥存储创建机密。
$ oc create secret generic <secret_name> --from-file=<keystore_filename.jks>
例如,对于
kitchensink
Quickstart,使用以下命令创建一个 secret。$ oc create secret generic eap7-app-secret --from-file=keystore.jks
2.3. 为 Red Hat Container Registry 配置身份验证
在导入并使用 JBoss EAP for OpenShift 镜像前,您必须首先为 Red Hat Container Registry 配置身份验证。
红帽建议您使用 registry 服务帐户创建身份验证令牌,以配置对 Red Hat Container Registry 的访问。这意味着您不必在 OpenShift 配置中使用或存储您的红帽帐户的用户名和密码。
- 按照红帽客户门户网站中的说明,使用 registry 服务帐户创建身份验证令牌。
- 下载包含令牌的 OpenShift secret 的 YAML 文件。您可以从令牌的 Token Information 页面上的 OpenShift Secret 选项卡下载 YAML 文件。
使用您下载的 YAML 文件为 OpenShift 项目创建身份验证令牌 secret:
oc create -f 1234567_myserviceaccount-secret.yaml
使用以下命令,为 OpenShift 项目配置 secret,将示例中的机密名称替换为上一步中创建的机密的名称。
oc secrets link default 1234567-myserviceaccount-pull-secret --for=pull oc secrets link builder 1234567-myserviceaccount-pull-secret --for=pull
如需有关配置 安全 registry 访问的其他方法的更多信息,请参阅 OpenShift 文档。
有关配置到 Red Hat Container Registry 进行身份验证的更多信息, 请参阅红帽客户门户网站。
2.4. 为 OpenShift Imagestreams 和 Templates 导入最新的 JBoss EAP
您必须将用于 OpenShift 镜像流和模板的最新 JBoss EAP 导入到 OpenShift 项目的命名空间。
使用您的客户门户网站凭证登录到 Red Hat Container Registry,以导入 JBoss EAP 镜像流和模板。如需更多信息,请参阅 Red Hat Container Registry 身份验证。
JDK 8 的导入命令
oc replace -f \ https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/eap74/eap74-openjdk8-image-stream.json
此命令导入以下镜像流和模板。
-
JDK 8 构建器镜像流:
jboss-eap74-openjdk8-openshift
-
JDK 8 运行时镜像流:
jboss-eap74-openjdk8-runtime-openshift
如果使用 OpenShift 3 并首次创建 EAP 7.4 ImageStream,请运行以下命令而不是 oc replace
:
oc create -f https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/eap74/eap74-openjdk8-image-stream.json
JDK 11 的导入命令
oc replace -f \ https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/eap74/eap74-openjdk11-image-stream.json
此命令导入以下镜像流和模板。
-
JDK 11 构建器镜像流:
jboss-eap74-openjdk11-openshift
-
JDK 11 运行时镜像流:
jboss-eap74-openjdk11-runtime-openshift
模板导入命令
for resource in \ eap74-amq-persistent-s2i.json \ eap74-amq-s2i.json \ eap74-basic-s2i.json \ eap74-https-s2i.json \ eap74-sso-s2i.json do oc replace -f \ https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/eap74/templates/${resource} done
此命令导入命令中指定的所有模板。
使用这些命令导入的 JBoss EAP 镜像流和模板仅在该 OpenShift 项目中可用。
如果您有对常规 openshift
命名空间的访问权限,并希望所有项目可以访问镜像流和模板,请在 命令的 oc replace
行中添加 -n openshift
。例如:
... oc replace -n openshift -f \ ...
如果使用 cluster-samples-operator,请参阅有关配置集群示例 Operator 的 OpenShift 文档。有关配置集群示例 Operator 的详情,请参阅配置 Samples Operator。
2.5. 将 JBoss EAP Source-to-Image(S2I)应用部署到 OpenShift
导入镜像和模板后,您可以将应用部署到 OpenShift。
先决条件
可选 :模板可以为多个模板参数指定默认值,您可能需要覆盖某些或全部默认值。要查看模板信息,包括参数列表和任何默认值,请使用 oc describe template TEMPLATE_NAME
命令。
流程
创建一个新的 OpenShift 应用,以使用 JBoss EAP 进行 OpenShift 镜像和 Java 应用的源代码。您可以将提供的 JBoss EAP 用于 S2I 构建的 OpenShift 模板之一。您也可以选择置备修剪的服务器。
例如,若要使用 JDK 8 构建器镜像部署
kitchensink
Quickstart,请输入以下命令在eap-demo
项目中使用eap74-basic-s2i
模板,在 准备 OpenShift for Application Deployment 中,使用 kitchensink 源代码在 GitHub 上进行kitchensink
源代码:这个快速入门不支持修剪功能。oc new-app --template=eap74-basic-s2i \ 1 -p IMAGE_STREAM_NAMESPACE=eap-demo \ 2 -p EAP_IMAGE_NAME=jboss-eap74-openjdk8-openshift:7.4.0 \ 3 -p EAP_RUNTIME_IMAGE_NAME=jboss-eap74-openjdk8-runtime-openshift:7.4.0 \ 4 -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts \ 5 -p SOURCE_REPOSITORY_REF=7.4.x \ 6 -p CONTEXT_DIR=kitchensink 7
再如,要使用 JDK 11 运行时镜像部署
helloworld-html5
quickstart,并修剪 JBoss EAP 以仅包含jaxrs-server
层,请输入以下命令。该命令使用eap-demo
项目中的eap74-basic-s2i
模板,在 准备 OpenShift for Application Deployment 中创建,使用 GitHub 上的helloworld-html5
源代码。oc new-app --template=eap74-basic-s2i \ 1 -p IMAGE_STREAM_NAMESPACE=eap-demo \ 2 -p EAP_IMAGE_NAME=jboss-eap74-openjdk11-openshift:7.4.0 \ 3 -p EAP_RUNTIME_IMAGE_NAME=jboss-eap74-openjdk11-runtime-openshift:7.4.0 \ 4 -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts \ 5 -p SOURCE_REPOSITORY_REF=7.4.x \ 6 -p GALLEON_PROVISION_LAYERS=jaxrs-server \ 7 -p CONTEXT_DIR=helloworld-html5 8
注意在创建新的 OpenShift 应用时,您可能还需要配置环境变量。
例如,如果您使用 HTTPS 模板,如
eap74-https-s2i
,您必须指定所需的 HTTPS 环境变量HTTPS
_NAME、HTTPS_PASSWORD
和HTTPS_KEYSTORE
,以匹配密钥存储详情。注意如果模板使用 AMQ,您必须包括带有适当值的
AMQ_IMAGE_NAME
参数。如果模板使用 SSO,则必须包括带有适当值的
SSO_IMAGE_NAME
参数。检索构建配置的名称。
$ oc get bc -o name
使用上一步中的构建配置的名称,查看构建的 Maven 进度。
$ oc logs -f buildconfig/BUILD_CONFIG_NAME
例如,对于
kitchensink
Quickstart,以下命令显示了 Maven 构建的进度。$ oc logs -f buildconfig/eap-app
2.6. 部署后任务
根据您的应用,可能需要在构建和部署 OpenShift 应用后执行一些任务。这可能包括公开服务,以便应用可从 OpenShift 以外查看,或者将应用程序扩展到特定数量的副本。
使用以下命令,获取应用程序的服务名称。
$ oc get service
将主服务作为路由公开,以便您可以从 OpenShift 外部访问您的应用。例如,对于
kitchensink
Quickstart,请使用以下命令公开所需的服务和端口。$ oc expose service/eap-app --port=8080
注意如果您使用模板来创建应用程序,则路由可能已存在。如果存在,请继续下一步。
获取路由的 URL。
$ oc get route
在浏览器中使用 URL 访问应用程序。URL 是上一命令输出中的
HOST/PORT
字段的值。如果您的应用程序没有使用 JBoss EAP root 上下文,请将应用的上下文附加到 URL。例如,对于
kitchensink
Quickstart,URL 可能是http://HOST_PORT_VALUE/kitchensink/
。另外,您还可以通过运行以下命令扩展应用程序实例。这会将副本数增加到
3
。$ oc scale deploymentconfig DEPLOYMENTCONFIG_NAME --replicas=3
例如,对于
kitchensink
Quickstart,请使用以下命令来扩展应用程序。$ oc scale deploymentconfig eap-app --replicas=3
2.7. 用于 OpenShift 的 JBoss EAP 中的链构建支持
用于 OpenShift 的 JBoss EAP 支持 OpenShift 中的串联构建。
用于 OpenShift 模板的 JBoss EAP 使用串联构建。当使用这些模板时,两个构建结果:
-
名为
[application name]-build-artifacts
的中间镜像 -
最终的镜像,
[应用程序名称]
有关串联构建的详情,请参阅 OpenShift 文档。
其它资源
第 3 章 使用 Helm Chart 在 OpenShift 上部署 JBoss EAP 7 应用程序
您可以使用 Helm chart 在 OpenShift 上使用 JBoss EAP 7 部署并运行 Jakarta EE 应用程序。Helm 是一个软件包管理程序,它简化了应用程序和服务部署到 OpenShift Container Platform 集群的过程。Helm 使用名为 chart 的打包格式。Helm chart 是描述 OpenShift Container Platform 资源的一个文件集合。以下流程演示了如何在 OpenShift Container Platform Web 控制台中使用 Helm chart 部署和运行 Jakarta EE 应用程序。
此功能仅作为技术预览提供。在生产环境中不支持使用它,并可能会在以后更改。如需有关技术预览功能支持范围的信息,请参阅红帽客户门户网站上的 技术预览功能支持范围。
3.1. 先决条件
- 已安装并运行 OpenShift 实例。如需有关安装和配置 OpenShift 实例的更多信息,请参阅 OpenShift Container Platform 入门指南。
- 已登陆到 OpenShift Container Platform Web 控制台。有关使用 OpenShift Web 控制台的更多信息,请参阅 OpenShift Container Platform 入门指南。
- 您还可以使用 OpenShift Sandbox 在 OpenShift Container Platform 上部署并运行 JBoss EAP 应用程序。这是一个试用沙盒,可在有限的时间内提供。
- 本文档使用 Jakarta EE 应用程序示例。您可以使用相同的步骤来部署自己的 Jakarta EE 应用。如需更多信息,请参阅 https://github.com/jboss-eap-up-and-running/eap7-getting-started
3.2. 使用 Helm 创建 JBoss EAP 7 应用程序
您可以使用 OpenShift Web 控制台中的 Helm Chart 创建 JBoss EAP 7 应用程序。
流程
- 在主导航中,点下拉菜单并选择 Developer。
在导航菜单中点 Add。
此时会打开 Add 页面。
- 在 Add 页面中,点 Helm Chart。
-
在 Helm Charts 目录中,搜索
JBoss EAP 7.4
。 点
JBoss EAP 7.4
Helm Chart 标题。侧面板显示有关 JBoss EAP 7 Helm Chart 的信息。
点 Install Helm Chart。
一些表单部分会被默认折叠。点 & gt; 扩展并查看其内容。
注意这些部分不需要更新才能继续。
在
build.uri
字段中指定有关您要构建和部署的 Jakarta EE 应用程序的详细信息。build: uri: https://github.com/jboss-eap-up-and-running/eap7-getting-started
注意如果要构建不同的应用程序,您必须更改此
uri
字段以指向该应用的 Git 存储库。- 点 Install 使用 Helm Chart 创建 JBoss EAP 7 应用程序。
验证
Helm 发行版本由一个短划线框表示,其中包含 JBoss EAP 图标和 eap74 文本。此内容放置在短划线框之外。部署通过短划线框中带有文本 D eap74 的圆圈来表示。
- 验证您是否看到 eap74 Helm 发行版本。
- 验证您是否看到 eap74 部署。
3.3. 查看 Helm 发行版本
使用 Helm Chart 成功创建 JBoss EAP 7 应用程序后,您可以查看与 Helm 发行版本相关的所有信息。
先决条件
- 已使用 Helm Chart 创建 JBoss EAP 7 应用程序。请参阅使用 Helm 创建 JBoss EAP 7 应用程序。
流程
- 在导航菜单中点 Helm。
点 eap74 Helm release。
Helm Release 详情页面 将打开。它显示与您安装 Helm 发行版本相关的所有信息。
- 单击 Resources 选项卡。它列出了此 Helm 发行版本创建的所有资源。
验证
-
验证您看到 Helm release
eap74
旁边的 Deployed 标签。
3.4. 查看关联的代码
使用 Helm Chart 成功创建 JBoss EAP 7 应用程序后,您可以查看关联的代码。
先决条件
- 已使用 Helm Chart 创建 JBoss EAP 7 应用程序。请参阅使用 Helm 创建 JBoss EAP 7 应用程序。
流程
在导航菜单中点 Topology。
在 Topology 视图中,eap74 部署在右下角显示一个代码图标。
此图标代表相关代码的 Git 存储库,或者安装了适当的运算符,它将在 IDE 中打开相关的代码。
- 如果显示的图标是 CodeReady Workspaces 或 Eclipse Che,请点击它在 IDE 中启动关联的代码。否则,点它导航到关联的 Git 存储库。
验证
- 验证您可以在 Git 存储库或 IDE 中看到与应用程序关联的代码。
3.5. 查看构建状态
使用 Helm Chart 成功创建 JBoss EAP 7 应用程序后,您可以查看构建状态。
先决条件
- 已使用 Helm Chart 创建 JBoss EAP 7 应用程序。请参阅使用 Helm 创建 JBoss EAP 7 应用程序。
流程
- 在导航菜单中点 Topology。
在 Topology 视图中,点 D eap74 图标。
此时会打开一个侧面板,其中包含有关应用程序的详细信息。
- 在侧面面板中,点 Resources 选项卡。Builds 部分显示与应用程序构建相关的所有详细信息。
JBoss EAP 7 应用程序以两个步骤构建:
-
第一个构建配置
eap74-build-artifacts
编译并打包 Jakarta EE 应用,并创建一个 JBoss EAP 服务器。应用在此 JBoss EAP 服务器上运行。
完成构建可能需要几分钟时间。构建通过各种状态(如 Pending
、Running
)进行 进度
。构建状态由相关消息表示。
构建完成后,会显示复选标记并显示以下消息: Build the1 is complete
-
第二个构建配置
eap74
将 Jakarta EE 部署和 JBoss EAP 服务器放在运行时镜像中,该镜像仅包含运行应用所需的内容。
第二个构建完成后,会显示复选标记并显示以下消息: Buildbang2 has complete
- 当第一个构建完成后,第二个构建将启动。
验证
验证
eap74-build-artifacts
和eap74
的两个构建已完成:-
对于
eap74-build-artifacts
构建配置,会显示 Build1141 is complete 信息。 -
对于
eap 74 构建配置,会显示 Build
bang2 信息。
-
对于
3.6. 查看 pod 状态
使用 Helm Chart 成功创建 JBoss EAP 7 应用程序后,您可以查看 pod 状态。
先决条件
- 已使用 Helm Chart 创建 JBoss EAP 7 应用程序。请参阅使用 Helm 创建 JBoss EAP 7 应用程序。
流程
- 在导航菜单中点 Topology。
在 Topology 视图中,点 D eap74。
此时会打开一个侧面板,其中包含有关应用程序的详细信息。
在 Details 选项卡中,将鼠标悬停在 pod 上,以在工具提示中查看 pod 状态。
- pod 数量显示在 pod 圆圈中。
pod circle 的颜色表示 pod status: Light blue =
Pending
, Blue =Not Ready
, Dark blue =Running
。注意在 Topology 视图中,
D eap74
部署图标的 dark outer circle 也表示 pod 状态。
验证
- 验证 pod circle 中的文本是否显示 1 个 pod。
- 当您将鼠标悬停在其中时,验证 Pod circle 是否显示 1 Running。
3.7. 运行 JBoss EAP 7 应用
使用 Helm 成功创建并构建 JBoss EAP 7 应用程序后,您可以访问它。
先决条件
- 您已创建了 JBoss EAP 7 应用。请参阅使用 Helm 创建 JBoss EAP 7 应用程序。
流程
在 Topology 视图中,单击右上角的外部链接图标打开 URL,并在一个单独的浏览器窗口中运行应用程序。
注意此操作会在 Web 浏览器窗口中打开 URL。
验证
- 验证 Red Hat OpenShift 上的应用 JBoss EAP 7 是否在一个单独的浏览器窗口中打开。
第 4 章 为 Java 应用配置 OpenShift 镜像的 JBoss EAP
用于 OpenShift 镜像的 JBoss EAP 预配置用于您的 Java 应用程序的基本用途。但是,您可以在镜像内配置 JBoss EAP 实例。推荐的方法是使用 OpenShift S2I 进程,以及应用模板参数和环境变量。
在容器重启或终止时,对正在运行的容器进行的任何配置更改都将丢失。
这包括使用传统 JBoss EAP 安装中包含的脚本进行的任何配置更改,如 add-user.sh
或 management CLI。
强烈建议您将 OpenShift S2I 进程与应用模板参数和环境变量一起用于 OpenShift 镜像,对 JBoss EAP 实例的任何配置更改。
4.1. OpenShift S2I Process 的 JBoss EAP 如何工作
说明 JBoss EAP 的 S2I 流程的流程图:
如果源代码存储库中存在
pom.xml
文件,S2I 构建器镜像将启动 Maven 构建流程。Maven 构建使用$MAVEN_ARGS
的内容。如果源代码存储库中不存在
pom.xml
文件,S2I 构建器镜像将启动二进制类型构建。要添加自定义 Maven 参数或选项,可使用
$MAVEN_ARGS_APPEND
。$MAVEN_ARGS_APPEND
变量附加选项到$MAVEN_ARGS
。默认情况下,OpenShift 配置集使用 Maven
软件包
目标,其中包括跳过测试的系统属性(-DskipTests
)并启用红帽 GA 存储库(-Dcom.redhat.xpaas.repo
)。成功 Maven 构建的结果复制到用于 OpenShift 镜像的 JBoss
EAP 中的EAP_HOME/standalone/deployments/
目录中。这包括$ARTIFACT_DIR
环境变量指定的源存储库中的所有 JAR、WAR 和 EAR 文件。ARTIFACT_DIR
的默认值为 Maven 目标目录。注意要将 JBoss EAP 上的代理后面的 Maven 用于 OpenShift 镜像,请设置
$HTTP_PROXY_HOST
和$HTTP_PROXY_PORT
环境变量。另外,您还可以设置$HTTP_PROXY_USERNAME
、$HTTP_PROXY_PASSWORD
和$HTTP_PROXY_NONPROXYHOSTS
变量。-
modules
源存储库目录中的所有文件复制到 OpenShift 镜像的 JBossEAP 中的EAP_HOME/modules/
目录中。 -
configuration
源存储库目录中的所有文件复制到 OpenShift 镜像的 JBossEAP 中的EAP_HOME/standalone/configuration/
目录中。如果要使用自定义 JBoss EAP 配置文件,将该文件命名为standalone-openshift.xml
。
其它资源
- 如需有关二进制类型构建的更多信息,请参阅 OpenShift 4.2 文档中的 Binary(本地)源。
- 如需了解如何指示 S2I 进程使用自定义 Maven 工件存储库镜像的其他指导,请参阅 Artifact Repository 镜像。
4.2. 配置 JBoss EAP for OpenShift 使用环境变量
使用环境变量是为 OpenShift 镜像配置 JBoss EAP 的建议方法。如需有关为应用程序容器和构建容器 指定环境变量 的说明,请参阅 OpenShift 文档。
例如,您可以在创建 OpenShift 应用程序时使用环境变量设置 JBoss EAP 实例的管理用户名和密码:
oc new-app --template=eap74-basic-s2i \ -p IMAGE_STREAM_NAMESPACE=eap-demo \ -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts \ -p SOURCE_REPOSITORY_REF=7.4.x \ -p CONTEXT_DIR=kitchensink \ -e ADMIN_USERNAME=myspecialuser \ -e ADMIN_PASSWORD=myspecialp@ssw0rd
参考资料信息 列出了用于 OpenShift 镜像的 JBoss EAP 的可用 环境变量。
4.2.1. JVM 内存配置
OpenShift EAP 镜像具有自动基于当前环境计算默认 JVM 内存设置的机制,但您也可以使用环境变量配置 JVM 内存设置。
4.2.1.1. JVM 默认内存设置
如果为当前容器定义了内存限制,并且限制小于可用内存,则会自动计算默认 JVM 内存设置。否则,默认的 JVM 内存设置是在用作镜像基础服务器的 EAP 版本的 standalone.conf
文件中定义的默认设置。
容器的内存限值从 /sys/fs/cgroup/memory/memory.limit_in_bytes
文件中检索。可用内存总量使用 / proc/meminfo
命令来检索。
自动计算内存设置时,使用以下公式:
- 最大堆大小(-Xmx):用户内存的 fifty percent(50%)
- 初始堆大小(-Xms):计算最大堆大小的二十五百(25%)。
例如,定义的内存限值为 1 GB,此限制低于 /proc/meminfo
报告的总可用内存,然后内存设置将为: -Xms128m -Xmx512
您可以使用以下环境变量来修改自动计算的 JVM 设置:请注意,仅当定义了有效容器内存限制时,这些变量才会自动计算默认内存大小(换句话说)。
-
JAVA_MAX_MEM_RATIO
-
JAVA_INITIAL_MEM_RATIO
-
JAVA_MAX_INITIAL_MEM
您可以通过将以下两个环境变量的值设置为 0 来禁用自动内存计算。
-
JAVA_INITIAL_MEM_RATIO
-
JAVA_MAX_MEM_RATIO
4.2.1.2. JVM 垃圾回收设置
OpenShift 的 EAP 镜像包含垃圾回收和垃圾回收日志的设置
垃圾回收设置
-XX:+UseParallelOldGC -XX:MinHeapFreeRatio=10 -XX:MaxHeapFreeRatio=20 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90 -XX:+ExitOnOutOfMemoryError
Java 8 的垃圾回收日志记录设置(非模块化 JVM)
-verbose:gc -Xloggc:/opt/eap/standalone/log/gc.log -XX:+PrintGCDetails -XX:+PrintGCDateStamps -XX:+UseGCLogFileRotation -XX:NumberOfGCLogFiles=5 -XX:GCFileSize=3M -XX:-TraceClassUnloading
Java 11 的垃圾回收日志记录设置(模块化 JVM)
-Xlog:gc*:file=/opt/eap/standalone/log/gc.log:time,uptimemillis:filecount=5,filesize=3M
4.2.1.3. 默认设置中的资源限值
如果设置,镜像中会包含其他默认设置。
-XX:ParallelGCThreads={core-limit} -Djava.util.concurrent.ForkJoinPool.common.parallelism={core-limit} -XX:CICompilerCount=2
{core-limit} 的值通过使用 JAVA_CORE_LIMIT
环境变量或容器实施的 CPU 内核限制来定义。
CICompilerCount
的值始终被固定为 2。
4.2.1.4. JVM 环境变量
使用这些环境变量在 EAP 中为 OpenShift 镜像配置 JVM。
表 4.1. JVM 环境变量
变量名称 | 示例 | 默认值 | JVM 设置 | 描述 |
---|---|---|---|---|
JAVA_OPTS | -verbose:class | 没有默认值 | Multiple |
传递给
使用
使用
另外,如果没有启用自动内存计算,则不会定义 inital Java 内存(-Xms)和最大 Java 内存(-Xmx)。
如果使用 |
JAVA_OPTS_APPEND | -Dsome.property=value | 没有默认值 | Multiple |
用户指定的 Java 选项以附加到 |
JAVA_MAX_MEM_RATIO | 50 | 50 | -Xmx |
当 |
JAVA_INITIAL_MEM_RATIO | 25 | 25 | -Xms |
在 |
JAVA_MAX_INITIAL_MEM | 4096 | 4096 | -Xms |
在 |
JAVA_DIAGNOSTICS | true | false(禁用) | 设置取决于容器使用的 JDK。
|
将这个变量的值设置为 true,以在事件发生时将诊断信息包含在标准输出中。如果在一个 |
DEBUG | true | false | -agentlib:jdwp=transport=dt_socket,address=$DEBUG_PORT,server=y,suspend=n | 启用远程调试。 |
DEBUG_PORT | 8787 | 8787 | -agentlib:jdwp=transport=dt_socket,address=$DEBUG_PORT,server=y,suspend=n | 指定用于调试的端口。 |
JAVA_CORE_LIMIT | 未定义 | -XX:parallelGCThreads -Djava.util.concurrent.ForkJoinPool.common.parallelism -XX:CICompilerCount | 对内核数的用户定义的限制。如果容器报告了限制约束,则 JVM 设置的值限制为容器核心限制。-XXCICompilerCount 的值始终为 2。默认情况下,此变量为 undefined。在这种情况下,如果没有在容器上定义限制,则不会设置 JVM 设置。 | |
GC_MIN_HEAP_FREE_RATIO | 20 | 10 | -XX:MinHeapFreeRatio | 垃圾回收后释放的最小堆百分比以避免扩展。 |
GC_MAX_HEAP_FREE_RATIO | 40 | 20 | -XX:MaxHeapFreeRatio | 垃圾回收后释放的最大堆百分比以避免缩小。 |
GC_TIME_RATIO | 4 | 4 | -XX:GCTimeRatio | 指定垃圾回收外花费的时间比率(例如,应用程序执行时间)与垃圾回收中花费的时间相对应。 |
GC_ADAPTIVE_SIZE_POLICY_WEIGHT | 90 | 90 | -XX:AdaptiveSizePolicyWeight | 赋予当前垃圾回收时间的权重,与之前的垃圾收集时间相对应。 |
GC_METASPACE_SIZE | 20 | 96 | -XX:MetaspaceSize | 初始的元空间大小。 |
GC_MAX_METASPACE_SIZE | 100 | 256 | -XX:MaxMetaspaceSize | 最大元空间大小。 |
GC_CONTAINER_OPTIONS | -XX:+UseG1GC | -XX:-UseParallelOldGC | -XX:-UseParallelOldGC | 指定要使用的 Java 垃圾回收。变量的值应当是 JRE 命令行选项来指定所需的垃圾回收。JRE 命令指定的会覆盖默认值。 |
以下环境变量已弃用:
-
JAVA_OPTIONS
:使用JAVA_OPTS
。 -
INITIAL_HEAP_PERCENT
: 使用JAVA_INITIAL_MEM_RATIO
。 -
CONTAINER_HEAP_PERCENT
: 使用JAVA_MAX_MEM_RATIO
。
4.3. 构建扩展和项目 Artifacts
用于 OpenShift 镜像的 JBoss EAP 使用各种工件扩展 OpenShift 中的数据库支持。这些工件通过不同的机制包含在构建的镜像中:
对使用带有 JBoss EAP 的红帽提供的内部数据源驱动程序的支持现已弃用。红帽建议将 JDBC 驱动程序从数据库厂商获取用于 JBoss EAP 应用程序。
JBoss EAP for OpenShift 镜像不再提供以下内部数据源:
- MySQL
- PostgreSQL
有关安装驱动程序的更多信息,请参阅模块、驱动程序和通用部署。
有关使用 JBoss EAP 配置 JDBC 驱动程序的更多信息,请参阅 JBoss EAP 配置指南中的 JDBC 驱动程序。
请注意,如果您想要将它们添加到置备的服务器,您也可以创建一个自定义层来安装这些驱动程序和数据源。
4.3.1. S2I Artifacts
S2I 工件包括模块、驱动程序和其他通用部署,它们提供部署所需的必要的配置基础架构。此配置内置在 S2I 过程中,以便在运行时配置数据源和相关资源适配器。
如需了解如何指示 S2I 进程利用自定义 Maven 工件存储库镜像的其他指导,请参阅 Artifact Repository 镜像。
4.3.1.1. 模块、驱动程序和通用部署
有几个选项可以在 JBoss EAP for OpenShift 镜像中包括这些 S2I 工件:
- 将工件包含在应用程序源部署目录中。工件会在构建期间下载,并注入到镜像中。这与在 JBoss EAP for OpenShift 镜像中部署一个应用程序类似。
包括
CUSTOM_INSTALL_DIRECTORIES
环境变量(一个以逗号分隔的目录列表),用于在 S2I 过程中为镜像安装和配置工件。在 S2I 中有两个方法包括以下信息:在提名的安装目录中的
install.sh
脚本。安装脚本在 S2I 过程中执行,并使用 impunity 操作。install.sh
脚本示例#!/bin/bash injected_dir=$1 source /usr/local/s2i/install-common.sh install_deployments ${injected_dir}/injected-deployments.war install_modules ${injected_dir}/modules configure_drivers ${injected_dir}/drivers.env
install.sh
脚本负责使用install-common.sh
提供的 API 自定义基础镜像。install-common.sh
包含install.sh
脚本用于安装和配置模块、驱动程序和通用部署的功能。install-common.sh
中包含的功能:-
install_modules
-
configure_drivers
install_deployments
模块
模块是用于类加载和依赖关系管理的逻辑分组。模块在应用服务器的
EAP_HOME/modules/
目录中定义。每个模块都作为子目录存在,如EAP_HOME/modules/org/apache/
。然后,每个模块目录都会包含一个插槽子目录,默认为 main,其中包含module.xml
配置文件和任何所需的 JAR 文件。有关为 MySQL 和 PostgreSQL JDBC 驱动程序配置
module.xml
文件的更多信息,请参阅 JBoss EAP 配置指南中的 Datasource 配置示例。PostgreSQL Datasource 的
module.xml
文件示例<?xml version="1.0" encoding="UTF-8"?> <module xmlns="urn:jboss:module:1.0" name="org.postgresql"> <resources> <resource-root path="postgresql-jdbc.jar"/> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
MySQL Connect/J 8 Datasource 的
module.xml
文件示例<?xml version="1.0" encoding="UTF-8"?> <module xmlns="urn:jboss:module:1.0" name="com.mysql"> <resources> <resource-root path="mysql-connector-java-8.0.Z.jar" /> </resources> <dependencies> <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
注意mysql-connector-java-8.0.Z.jar
中的 ".Z" 指示所下载的JAR
文件的版本。可以重命名该文件,但名称必须与module.xml
文件中的名称匹配。install.sh
中的install_modules
功能会将对应的 JAR 文件复制到 JBoss EAP 中的模块目录中,以及module.xml
。驱动程序
驱动程序作为模块安装。然后,这个驱动程序由
configure_drivers
函数在install.sh
中配置,该配置属性在运行时工件环境文件中定义。添加数据源驱动程序
MySQL 和 PostgreSQL 数据源不再作为预先配置的内部数据源提供。您仍然可以将这些驱动程序作为模块安装;请参阅模块、驱动程序和通用部署中的描述。您可以从 JBoss EAP 应用程序的数据库供应商处获取这些 JDBC 驱动程序。
为每个要安装的数据源创建一个
drivers.env
文件。MySQL Datasource 的
driver.env
文件示例#DRIVER DRIVERS=MYSQL MYSQL_DRIVER_NAME=mysql MYSQL_DRIVER_MODULE=org.mysql MYSQL_DRIVER_CLASS=com.mysql.cj.jdbc.Driver MYSQL_XA_DATASOURCE_CLASS=com.mysql.cj.jdbc.MysqlXADataSource
PostgreSQL Datasource 的
driver.env
文件示例#DRIVER DRIVERS=POSTGRES POSTGRES_DRIVER_NAME=postgresql POSTGRES_DRIVER_MODULE=org.postgresql POSTGRES_DRIVER_CLASS=org.postgresql.Driver POSTGRES_XA_DATASOURCE_CLASS=org.postgresql.xa.PGXADataSource
有关下载不同驱动程序(如 MySQL 或 PostgreSQL)的信息,请参阅配置指南中的 JDBC 驱动程序下载位置。
-
通用部署
可以使用 install-common.sh
中的 install_deployments
功能从注入的镜像部署可部署资源,如 JAR、WAR、RAR 或 EARs。
如果已经声明了
CUSTOM_INSTALL_DIRECTORIES
环境变量,但没有在自定义安装目录中找到install.sh
脚本,则以下工件目录将复制到构建镜像中对应的目的地:-
modules/*
复制到$JBOSS_HOME/modules/
-
configuration/*
复制到$JBOSS_HOME/standalone/configuration
-
deployments/*
复制到$JBOSS_HOME/standalone/deployments
这是与
install.sh
替代方案相比的基本配置方法,需要正确构建工件。-
4.3.2. 运行时工件
4.3.2.1. datasources
数据源有两种类型:
- 内部数据源.这些数据源在 OpenShift 上运行,但默认情况下无法通过 Red Hat Registry 或 OpenShift 存储库提供。这些数据源的配置由添加到 OpenShift Secret 的环境文件提供。
- 外部数据源.这些数据源不在 OpenShift 中运行。外部数据源的配置由添加到 OpenShift Secret 的环境文件提供。
有关创建和配置 OpenShift Secret 的更多信息,请参阅 Secret。
您可以在目录中创建数据源环境文件,如源项目的配置目录。以下示例显示了示例数据源环境文件的内容:
示例:数据源环境文件
DB_SERVICE_PREFIX_MAPPING=PostgresXA-POSTGRES=DS1 DS1_JNDI=java:jboss/datasources/pgds DS1_DRIVER=postgresql-42.2.5.jar DS1_USERNAME=postgres DS1_PASSWORD=postgres DS1_MAX_POOL_SIZE=20 DS1_MIN_POOL_SIZE=20 DS1_CONNECTION_CHECKER=org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLValidConnectionChecker DS1_EXCEPTION_SORTER=org.jboss.jca.adapters.jdbc.extensions.postgres.PostgreSQLExceptionSorter
DB_SERVICE_PREFIX_MAPPING
属性是一个以逗号分隔的数据源属性前缀列表。然后,这些前缀会附加到该数据源的所有属性中。然后,可以将多个数据源包含在一个环境文件中。另外,还可在单独的环境文件中提供各个数据源。
datasources 包含两种类型的属性:连接池相关的属性,以及特定于数据库驱动程序的属性。连接池特定的属性生成与数据源的连接。数据库驱动程序的属性决定数据源的驱动程序,并配置为驱动程序 S2I 工件。
在上例中,DS1
是数据源前缀,CONNECTION_CHECKER
指定用于验证数据库的连接检查器类,而 EXCEPTION_SORTER
指定用来检测致命数据库连接异常分类器类。
datasources 环境文件添加到项目的 OpenShift Secret 中。这些环境文件然后在模板中使用 ENV_FILES
环境属性调用,其值是完全限定环境文件的逗号分隔列表,如下所示。
{ “Name”: “ENV_FILES”, “Value”: “/etc/extensions/datasources1.env,/etc/extensions/datasources2.env” }
4.3.2.2. 资源适配器
资源适配器的配置由添加到 OpenShift Secret 的环境文件提供。
表 4.2. 资源适配器属性
属性 | 描述 |
---|---|
PREFIX_ID | 在服务器配置文件中指定的资源适配器标识符。 |
PREFIX_ARCHIVE | 资源适配器归档。 |
PREFIX_MODULE_SLOT |
插槽子目录,其中包含 |
PREFIX_MODULE_ID | 从其中载入对象工厂 Java 类的 JBoss 模块 ID。 |
PREFIX_CONNECTION_CLASS | 受管连接工厂或 admin 对象的完全限定类名称。 |
PREFIX_CONNECTION_JNDI | 连接工厂的 JNDI 名称。 |
PREFIX_PROPERTY_ParentDirectory | 保存数据文件的目录。 |
PREFIX_PROPERTY_AllowParentPaths |
将 |
PREFIX_POOL_MAX_SIZE | 池连接的最大数量。每个子池不会创建更多连接。 |
PREFIX_POOL_MIN_SIZE | 池的最小连接数。 |
PREFIX_POOL_PREFILL | 指定是否应预先填充池。更改此值需要重启服务器。 |
PREFIX_POOL_FLUSH_STRATEGY |
在出错时,应该如何清除池。有效值为: |
RESOURCE_ADAPTERS
属性是资源适配器属性前缀的逗号分隔列表。然后,这些前缀会附加到该资源适配器的所有属性中。然后可在单个环境文件中包含多个资源适配器。在以下示例中,MYRA
用作资源适配器的前缀。另外,可在单独的环境文件中提供每个资源适配器。
示例:资源适配器环境文件
#RESOURCE_ADAPTER RESOURCE_ADAPTERS=MYRA MYRA_ID=myra MYRA_ARCHIVE=myra.rar MYRA_CONNECTION_CLASS=org.javaee7.jca.connector.simple.connector.outbound.MyManagedConnectionFactory MYRA_CONNECTION_JNDI=java:/eis/MySimpleMFC
资源适配器环境文件添加到项目命名空间的 OpenShift Secret 中。这些环境文件然后在模板中使用 ENV_FILES
环境属性调用,其值是完全限定环境文件的逗号分隔列表,如下所示。
{ "Name": "ENV_FILES", "Value": "/etc/extensions/resourceadapter1.env,/etc/extensions/resourceadapter2.env" }
4.4. 将 JBoss EAP 模板用于 OpenShift 的结果
当您使用 JBoss EAP 模板编译应用程序时,可能会生成两个镜像。
创建了名为 [application name]-build-artifacts
的中间镜像,可以在最终镜像 [application name] [application name]
之前生成。
您可以在部署应用程序后删除 [application name]-build-artifacts
镜像。
4.5. Red Hat JBoss Enterprise Application Platform for OpenShift 镜像的 SSO 配置
在 Red Hat JBoss Enterprise Application Platform for OpenShift 镜像中,SSO 被配置为使用传统的 security
子系统。
在这些镜像中,环境变量 SSO_FORCE_LEGACY_SECURITY
被设置为 true
。
如果要使用 elytron
子系统进行 SSO 安全性,请将 SSO_FORCE_LEGACY_SECURITY
环境变量的值更新为 false
。
4.6. 默认数据源
数据源 ExampleDS
在 JBoss EAP 7.4 中不可用。
有些快速入门需要这个数据源:
-
cmt
-
thread-racing
客户开发的应用程序可能还需要 ExampleDS
数据源。
如果您需要默认数据源,请使用 GENERATE_DEFAULT_DATASOURCE
环境变量,在调配 JBoss EAP 服务器时包含它。
ENABLE_GENERATE_DEFAULT_DATASOURCE=true
第 5 章 JBoss EAP for OpenShift 中减少的能力
在构建包含 JBoss EAP 的镜像时,您可以控制要在镜像中包含的 JBoss EAP 功能和子系统。
S2I 镜像中包含的默认 JBoss EAP 服务器包括完整的服务器和所有功能。您可能需要修剪调配的服务器中包含的功能。例如,您可能希望降低调配服务器的安全风险,或者您可能希望减少内存占用量,使其更适合微服务容器。
5.1. 置备自定义 JBoss EAP 服务器
要置备具有修剪功能的自定义服务器,请在 S2I 构建阶段传递 GALLEON_PROVISION_LAYERS
环境变量。
环境变量的值是要置备的层的逗号分隔列表,以构建服务器。
例如,如果您将环境变量指定为 GALLEON_PROVISION_LAYERS=jaxrs-server,
则 JBoss EAP 服务器将具有以下功能:
- servlet 容器
- 配置数据源的功能
-
jaxrs
、weld
和jpa
子系统 - Red Hat SSO 集成
5.2. 可用的 JBoss EAP 层
红帽为 OpenShift 中的 JBoss EAP 服务器的自定义置备提供了六个层。
三个层是提供核心功能的基础层。三个是增强基本层的层。
任何置备层都不支持以下 Jakarta EE 规格:
- jakarta Server Faces 2.3
- Jakarta Enterprise Beans 3.2
- jakarta XML Web Services 2.3
5.2.1. 基本层
每个基本层包括典型服务器用户案例的核心功能。
datasources-web-server
此层包含一个 servlet 容器,以及配置数据源的功能。
以下是 datasources-web-server
中默认包含的 JBoss EAP 子系统:
-
core-management
-
datasources
-
deployment-scanner
-
ee
-
elytron
-
io
-
jca
-
jmx
-
logging
-
naming
-
request-controller
-
security-manager
-
事务
-
undertow
此层支持以下 Jakarta EE 规格:
- Jakarta JSON Processing 1.1
- jakarta JSON Binding 1.0
- jakarta Servlet 4.0
- Jakarta Expression Language 3.0
- Jakarta Server Pages 2.3
- Jakarta Standard Tag Library 1.2
- jakarta Concurrency 1.1
- jakarta Annotations 1.3
- jakarta XML Binding 2.3
- Jakarta Debugging Support for Other Languages 1.0
- jakarta Transactions 1.3
- jakarta Connectors 1.7
jaxrs-server
此层通过以下 JBoss EAP 子系统增强了 datasources-web-server
层:
-
jaxrs
-
weld
-
jpa
此层还在容器中本地添加了基于 Infinispan 的第二级实体缓存。
除了 datasources-web-server
层支持的那些层,还需要以下 Jakarta EE 规格:
- jakarta 上下文和依赖注入 2.0
- jakarta Bean Validation 2.0
- jakarta Interceptors 1.2
- Jakarta RESTful Web Services 2.1
- jakarta Persistence 2.2
cloud-server
此层通过以下 JBoss EAP 子系统增强了 jaxrs-server
层:
-
resource-adapters
-
messaging-activemq
(远程代理消息传递,非嵌入式消息传递)
这个层还会在 jaxrs-server
层中添加以下可观察功能:
- 健康子系统
- 指标子系统
除了 jaxrs-server
层支持的外,该层还支持以下 Jakarta EE 规格:
- jakarta Security 1.0
5.2.2. Decorator 层
Decorator 层不会独立使用。您可以使用基本层配置一个或多个 decorator 层,以提供额外的功能。
sso
这种 decorator 层将 Red Hat Single Sign-On 集成到置备的服务器。
Observability(可观察性)
这个 decorator 层在置备的服务器中添加以下可观察功能:
- 健康子系统
- 指标子系统
这个层内置于 cloud-server
层。您不需要将此层添加到 cloud-server
层。
web-clustering
此层将嵌入式基于 Infinispan 的 Web 会话集群添加到调配的服务器。
5.3. 在 JBoss EAP 中置备用户开发的层
除了红帽提供的配置层外,您还可以配置您开发的自定义层。
流程
使用 Galleon Maven 插件构建自定义层。
如需更多信息 ,请参阅准备 Maven 项目。
- 将自定义层部署到可访问的 Maven 存储库。
您可以使用自定义 Galleon 功能包环境变量在 S2I 镜像构建过程中自定义 Galleon 功能包和层。
有关自定义 Galleon 功能包和层的更多信息,请参阅在 S2I 构建期间使用自定义 Galleon 功能包。
可选: 创建一个自定义调配文件来引用用户定义的层并支持的 JBoss EAP 层并将其存储在应用程序目录中。
有关创建自定义配置文件的更多信息,请参阅为 JBoss EAP 自定义调配文件。
运行 S2I 流程以在 OpenShift 中调配 JBoss EAP 服务器。
如需更多信息,请参阅在 S2I 构建过程中使用自定义 Galleon 功能包。
5.3.1. 为 JBoss EAP 构建和部署 Galleon 层
自定义 Galleon 层打包在 Galleon 功能包中,该包设计为使用 JBoss EAP 7.4 运行。
在 Openshift 中,您可以构建并使用 Galleon 功能包,其中包含要置备的层,例如,JBoss EAP 7.4 服务器的 MariaDB 驱动程序和数据源。层包含服务器上安装的内容。层可以更新服务器 XML 配置文件,并在服务器安装中添加内容。
本节记录了如何在 OpenShift 中构建和使用 Galleon 功能包,其中包含层为 JBoss EAP 7.4 服务器置备 MariaDB 驱动程序和数据源。
5.3.1.1. 准备 Maven 项目
Galleon 功能包使用 Maven 创建。此流程包括创建新 Maven 项目的步骤。
流程
要创建新 Maven 项目,请运行以下命令:
mvn archetype:generate -DarchetypeGroupId=org.codehaus.mojo.archetypes -DarchetypeArtifactId=pom-root -DgroupId=org.example.mariadb -DartifactId=mariadb-galleon-pack -DinteractiveMode=false
在
mariadb-galleon-pack
目录中,更新pom.xml
文件,使其包含 Red Hat Maven 存储库:<repositories> <repository> <id>redhat-ga</id> <name>Redhat GA</name> <url>https://maven.repository.redhat.com/ga/</url> </repository> </repositories>
更新
pom.xml
文件,以添加 EAP Galleon 功能包和 MariaDB 驱动程序的依赖项:<dependencies> <dependency> <groupId>org.jboss.eap</groupId> <artifactId>wildfly-ee-galleon-pack</artifactId> <version>7.4.4.GA-redhat-00011</version> <type>zip</type> </dependency> <dependency> <groupId>org.mariadb.jdbc</groupId> <artifactId>mariadb-java-client</artifactId> <version>3.0.5</version> </dependency> </dependencies>
更新
pom.xml
文件,使其包含用于构建 Galleon feature-pack 的 Maven 插件:<build> <plugins> <plugin> <groupId>org.wildfly.galleon-plugins</groupId> <artifactId>wildfly-galleon-maven-plugin</artifactId> <version>5.2.11.Final</version> <executions> <execution> <id>mariadb-galleon-pack-build</id> <goals> <goal>build-user-feature-pack</goal> </goals> <phase>compile</phase> </execution> </executions> </plugin> </plugins> </build>
5.3.1.2. 添加功能包内容
这个过程帮助您将层添加到自定义 Galleon 功能包中,例如:功能包,包括 MariaDB 驱动程序和数据源层。
先决条件
- 您已创建了一个 Maven 项目。如需了解更多详细信息 ,请参阅准备 Maven 项目。
流程
-
在自定义功能包 Maven 项目中创建目录
src/main/resources
,例如 准备 Maven 项目。该目录是包含 feature-pack 内容的根目录。 -
创建
src/main/resources/modules/org/mariadb/jdbc/main
目录。 在
主目录中
,创建一个名为module.xml
的文件,其内容如下:<?xml version="1.0" encoding="UTF-8"?> <module name="org.mariadb.jdbc" xmlns="urn:jboss:module:1.8"> <resources> <artifact name="${org.mariadb.jdbc:mariadb-java-client}"/> 1 </resources> <dependencies> 2 <module name="javax.api"/> <module name="javax.transaction.api"/> </dependencies> </module>
-
创建
src/main/resources/layers/standalone/
目录。这是 Galleon 功能包定义的所有层的根目录。 -
创建
src/main/resources/layers/standalone/mariadb-driver
目录。 在
mariadb-driver
目录中,使用以下内容创建layer-spec.xml
文件:<?xml version="1.0" ?> <layer-spec xmlns="urn:jboss:galleon:layer-spec:1.0" name="mariadb-driver"> <feature spec="subsystem.datasources"> 1 <feature spec="subsystem.datasources.jdbc-driver"> <param name="driver-name" value="mariadb"/> <param name="jdbc-driver" value="mariadb"/> <param name="driver-xa-datasource-class-name" value="org.mariadb.jdbc.MariaDbDataSource"/> <param name="driver-module-name" value="org.mariadb.jdbc"/> </feature> </feature> <packages> 2 <package name="org.mariadb.jdbc"/> </packages> </layer-spec>
mariadb-driver
层使用由JBoss 模块模块
实施的 JDBC 驱动程序配置更新数据源子系统。-
创建
src/main/resources/layers/standalone/mariadb-datasource
目录。 在
mariadb-datasource
目录中,使用以下内容创建layer-spec.xml
文件:<?xml version="1.0" ?> <layer-spec xmlns="urn:jboss:galleon:layer-spec:1.0" name="mariadb-datasource"> <dependencies> <layer name="mariadb-driver"/> 1 </dependencies> <feature spec="subsystem.datasources.data-source"> 2 <param name="data-source" value="MariaDBDS"/> <param name="jndi-name" value="java:jboss/datasources/${env.MARIADB_DATASOURCE:MariaDBDS}"/> <param name="connection-url" value="jdbc:mariadb://${env.MARIADB_HOST:localhost}:${env.MARIADB_PORT:3306}/${env.MARIADB_DATABASE}"/> 3 <param name="driver-name" value="mariadb"/> <param name="user-name" value="${env.MARIADB_USER}"/>4 <param name="password" value="${env.MARIADB_PASSWORD}"/> </feature> </layer-spec>
运行以下命令构建 Galleon 功能包:
mvn clean install
创建文件
target/mariadb-galleon-pack-1.0-SNAPSHOT.zip
。
5.3.1.3. 在 S2I 构建过程中使用自定义 Galleon 功能包
自定义功能包必须提供给 OpenShift S2I 构建期间发生的 Maven 构建。这通常通过将自定义功能包部署为工件来实现,例如 org.example.mariadb:mariadb-galleon-pack:1.0-SNAPSHOT
到可访问的 Maven 存储库。
要在部署前测试 feature-pack,您可以使用 EAP S2I 构建器镜像功能,允许您使用本地构建的 Galleon 功能包。使用以下步骤使用 MariaDB 驱动程序来自定义 todo-backend
EAP Quickstart,而不是 PostgreSQL 驱动程序。
-
有关
todo-backend
EAP Quickstart 的更多信息,请参阅 EAP Quickstart。 - 有关为自定义 Galleon 功能包使用配置 JBoss EAP S2I 镜像的更多信息,请参阅使用 高级环境变量配置 Galleon。
先决条件
- 已安装 OpenShift 命令行
- 已登陆到 OpenShift 集群
- 已在集群中安装了 JBoss EAP OpenShift 镜像
-
您已配置了对
Red Hat Container
registry 的访问。如需更多信息,请参阅 Red Hat Container Registry。 - 您已创建了自定义 Galleon 功能包。如需更多信息 ,请参阅准备 Maven 项目。
流程
运行以下命令启动 MariaDB 数据库:
oc new-app -e MYSQL_USER=admin -e MYSQL_PASSWORD=admin -e MYSQL_DATABASE=mariadb registry.redhat.io/rhscl/mariadb-101-rhel7
OpenShift service
mariadb-rhcsrhel7
已创建并启动。在 Maven 项目目录
mariadb-galleon-pack
中运行以下命令来从 feature-pack ZIP 归档创建 secret,由自定义 feature-pack Maven 构建生成:oc create secret generic mariadb-galleon-pack --from-file=target/mariadb-galleon-pack-1.0-SNAPSHOT.zip
创建 secret
mariadb-galleon-pack
。启动 S2I 构建时,此机密用于在 pod 中挂载 feature-pack zip 文件,以便在服务器置备阶段提供该文件。要创建新的 OpenShift 构建来构建包含通过 Galleon 修剪的服务器内的
todo-backend
quickstart 部署的应用程序镜像,请运行以下命令:oc new-build jboss-eap74-openjdk11-openshift:latest~https://github.com/jboss-developer/jboss-eap-quickstarts#EAP_7.4.0.GA \ --context-dir=todo-backend \ --env=GALLEON_PROVISION_FEATURE_PACKS="org.example.mariadb:mariadb-galleon-pack:1.0-SNAPSHOT" \ 1 --env=GALLEON_PROVISION_LAYERS="jaxrs-server,mariadb-datasource" \ 2 --env=GALLEON_CUSTOM_FEATURE_PACKS_MAVEN_REPO="/tmp/repo" \ 3 --env=MAVEN_ARGS_APPEND="-Dcom.redhat.xpaas.repo.jbossorg" \ --build-secret=mariadb-galleon-pack:/tmp/repo/org/example/mariadb/mariadb-galleon-pack/1.0-SNAPSHOT \ 4 --name=todos-app-build
- 1
- 包含以逗号分隔的功能包 Maven 协调列表的自定义 feature-pack 环境变量,如
groupId:artifactId:version
。 - 2
- 用于置备服务器的 Galleon 层集合。
jaxrs-server
是一个基本的服务器层,mariadb-datasource
是自定义层,它会将 MariaDB 驱动程序和新的数据源引入到服务器安装。 - 3
- 包含 MariaDB 功能包的镜像中本地 Maven 存储库的位置。在镜像中挂载 secret 时,此软件仓库会被填充。
- 4
mariadb-galleon-pack
secret 挂载到/tmp/repo/org/example/mariadb/mariadb-galleon-pack/1.0-SNAPSHOT
目录中。
要从创建的 OpenShift 构建启动新构建,请运行以下命令:
oc start-build todos-app-build
成功执行命令后,会创建镜像
todos-app-build
。要创建新部署,请执行以下命令,提供将数据源绑定到正在运行的 MariaDB 数据库所需的环境变量:
oc new-app --name=todos-app todos-app-build \ --env=MARIADB_PORT=3306 \ --env=MARIADB_USER=admin \ --env=MARIADB_PASSWORD=admin \ --env=MARIADB_HOST=mariadb-101-rhel7 \ --env=MARIADB_DATABASE=mariadb \ --env=MARIADB_DATASOURCE=ToDos 1
- 1
- Quickstart 期望数据源命名为
ToDos
注意有关自定义 Galleon 功能包环境变量的详情,请参阅自定义 Galleon 功能包环境变量
要公开
todos-app
应用程序,请运行以下命令:oc expose svc/todos-app
要创建新任务,请运行以下命令:
curl -X POST http://$(oc get route todos-app --template='{{ .spec.host }}') \ -H 'Content-Type: application/json' \ -d '{"title":"todo1"}'
要访问任务列表,请运行以下命令:
curl http://$(oc get route todos-app --template='{{ .spec.host }}')
添加的任务显示在浏览器中。
5.3.1.4. JBoss EAP 的自定义配置文件
自定义配置文件是 XML 文件,文件名 provisioning.xml
存储在 galleon
子目录中。
使用 provisioning.xml
文件是 GALLEON_PROVISION_FEATURE_PACKS
和 GALLEON_PROVISION_LAYERS
环境变量的替代选择。在 S2I 构建期间,provisioning.xml
文件用于调配自定义 EAP 服务器。
当使用 GALLEON_PROVISION_LAYERS
环境变量时,不要创建自定义置备文件,因为这个环境变量将 S2I 构建过程配置为忽略该文件。
以下代码演示了一个自定义配置文件。
<?xml version="1.0" ?> <installation xmlns="urn:jboss:galleon:provisioning:3.0"> <feature-pack location="eap-s2i@maven(org.jboss.universe:s2i-universe)">1 <default-configs inherit="false"/>2 <packages inherit="false"/>3 </feature-pack> <feature-pack location="org.example.mariadb:mariadb-galleon-pack:1.0-SNAPSHOT">4 <default-configs inherit="false"/> <packages inherit="false"/> </feature-pack> <config model="standalone" name="standalone.xml">5 <layers> <include name="jaxrs-server"/> <include name="mariadb-datasource"/> </layers> </config> <options>6 <option name="optional-packages" value="passive+"/> </options> </installation>
- 1
- 此元素指示调配过程来调配当前的eap-s2i 功能-pack。请注意,构建器镜像仅包含一个功能 pack。
- 2
- 此元素指示置备过程排除默认配置。
- 3
- 此元素指示调配过程排除默认软件包。
- 4
- 此元素指示调配过程调配
org.example.mariadb:mariadb-galleon-pack:1.0-SNAPSHOT
功能包。子元素指示进程排除默认配置和默认软件包。 - 5
- 此元素指示调配过程创建自定义独立配置。配置包括来自
org.example.mariadb:mariadb-galleon-pack:1.0-SNAPSHOT
功能包的jaxrs-server
基础层和mariadb-datasource
自定义层。 - 6
- 此元素指示调配流程来优化 JBoss EAP 模块的调配。
其他资源
-
有关使用
GALLEON_PROVISION_LAYERS
环境变量的更多信息,请参阅调配自定义 JBoss EAP 服务器。
5.3.2. 使用高级环境变量配置 Galleon
您可以使用高级自定义 Galleon 功能软件包环境变量来自定义在 S2I 镜像构建过程中存储自定义 Galleon 功能包和层的位置。这些高级自定义 Galleon 功能 pack 环境变量如下:
-
GALLEON_DIR=<path>
,将默认的<project_root_dir>/galleon
目录路径覆盖为<project_root_dir>/<GALLEON_DIR>
。 -
GALLEON_CUSTOM_FEATURE_PACKS_MAVEN_REPO=<path>
, 将<project root dir>/galleon/repository
目录路径改为一个到 Maven 本地存储库缓存目录的绝对路径。这个软件仓库包含自定义 Galleon 功能软件包。
您必须在与 Maven local-cache 文件系统配置兼容的子目录中找到 Galleon feature pack 归档文件。例如,找到 org.examples:my-feature-pack:1.0.0.Final
feature pack in the path-to-repository/org/examples/my-feature-pack/1.0.0.Final/my-feature-pack-1.0.0.Final.zip
路径。
您可以通过在 <project_root>/<GALLEON_DIR>
目录中创建一个 settings.xml
文件来配置您的 Maven 项目设置。GALLEON_DIR
的默认值为 <project_root_dir>/galleon
。Maven 使用 文件为应用程序置备自定义 Galleon 功能软件包。如果您没有创建 settings.xml
文件,Maven 将使用 S2I 镜像创建的默认 settings.xml
文件。
不要在 settings.xml
文件中指定本地 Maven 存储库位置,因为 S2I 构建器镜像指定了本地 Maven 存储库的位置。S2I 构建器镜像在 S2I 构建过程中使用此位置。
其他资源
- 有关自定义 Galleon 功能软件包环境变量的更多信息,请参阅自定义 Galleon 功能 pack 环境变量。
5.3.3. 自定义 Galleon 功能 pack 环境变量
您可以使用以下自定义 Galleon 功能软件包环境变量来自定义如何使用 JBoss EAP S2I 镜像。
表 5.1. 自定义 Galleon 功能软件包环境变量的描述
环境变量 | 描述 |
---|---|
GALLEON_DIR=<path> |
其中 <path > 是一个相对于应用程序项目根目录的目录。您的 <path> 目录包含您的可选 Galleon 自定义内容,如
目录默认为 |
GALLEON_CUSTOM_FEATURE_PACKS_MAVEN_REPO=<path> |
<path> 是包含自定义 feature-packs 的 Maven 本地存储库目录的绝对路径。目录默认为 |
GALLEON_PROVISION_FEATURE_PACKS=<list_of_galleon_feature_packs> | <list_of_galleon_feature_packs> 是 Maven 协调标识的自定义 Galleon 功能包的逗号分隔列表。列出的功能包必须与构建器镜像中存在的 JBoss EAP 7.4 服务器版本兼容。
您可以使用 |
第 6 章 故障排除
6.1. Pod 重启故障排除
Pod 可能会出于多种原因重启,但 JBoss EAP pod 重启的常见原因可能包括 OpenShift 资源约束,特别是内存不足的问题。如需有关 OpenShift pod 驱除的更多信息,请参阅 OpenShift 文档。
默认情况下,将 OpenShift 模板的 JBoss EAP 配置为在遇到内存不足问题等情况时自动重新启动受影响的容器。以下步骤可帮助您诊断和排除内存不足和其他 pod 重启问题。
获取有问题的 pod 的名称。
您可以使用以下命令查看 pod 名称以及每个 Pod 重启的次数。
$ oc get pods
若要诊断 Pod 重启的原因,您可以检查上一 Pod 的 JBoss EAP 日志或 OpenShift 事件。
要查看以上 pod 的 JBoss EAP 日志,请使用以下命令:
oc logs --previous POD_NAME
要查看 OpenShift 事件,请使用以下命令:
$ oc get events
- 如果因为资源问题而重启 Pod,您可以尝试修改 OpenShift Pod 配置以增加其 资源请求和限制。有关配置 pod 计算资源的更多信息,请参阅 OpenShift 文档。
6.2. 使用 JBoss EAP 管理 CLI 故障排除
JBoss EAP 管理 CLI( EAP_HOME/bin/jboss-cli.sh
)可从容器内访问,以进行故障排除。
不建议使用 JBoss EAP 管理 CLI 在运行的 pod 中进行配置更改。在容器重启时,使用管理 CLI 进行的任何配置更改都会丢失。
要进行 OpenShift 的 JBoss EAP 配置更改,请参阅为 Java 应用配置 JBoss EAP。
首先打开与正在运行的 pod 的远程 shell 会话。
$ oc rsh POD_NAME
在远程 shell 会话中运行以下命令启动 JBoss EAP 管理 CLI:
$ /opt/eap/bin/jboss-cli.sh
第 7 章 用于在 OpenShift 上自动化应用程序部署的 EAP Operator
EAP 操作器是扩展 OpenShift API 的 JBoss EAP 特定控制器。您可以使用 EAP 操作器创建、配置、管理和无缝升级复杂有状态应用的实例。
EAP 操作器在集群中管理多个 JBoss EAP Java 应用程序实例。它还通过在缩减副本前验证所有事务完成,并将 pod 标记为 clean
以进行终止,确保应用程序集群中的安全事务恢复。EAP operator 使用 StatefulSet
来处理 Jakarta Enterprise Beans remoting 和事务恢复处理。StatefulSet
确保持久性存储和网络主机名稳定性,即使 pod 重启后也是如此。
您必须使用 OperatorHub 安装 EAP 操作器,供 OpenShift 集群管理员用来发现、安装和升级操作器。
在 OpenShift Container Platform 4 中,您可以使用 Operator Lifecycle Manager(OLM)安装、更新和管理所有 Operator 以及在多个集群中运行的关联服务的生命周期。
OLM 在 OpenShift Container Platform 4 中默认运行。它帮助集群管理员对集群上运行的 Operator 进行安装、升级和授予访问权。OpenShift Container Platform Web 控制台为集群管理员提供了管理界面,以便集群管理员使用集群中可用的 Operator 目录并授予特定的项目访问权限。
如需有关 operator 和 OLM 的更多信息,请参阅 OpenShift 文档。
7.1. 使用 Web 控制台安装 EAP Operator
作为 JBoss EAP 集群管理员,您可以使用 OpenShift Container Platform Web 控制台从 Red Hat OperatorHub 安装 EAP operator。然后,您可以将 EAP operator 订阅至一个或多个命名空间,供集群上的开发人员使用。
在使用 Web 控制台安装 EAP operator 之前,您必须注意以下几个点:
- Installation Mode:选择 All namespaces on the cluster(default) 以在所有命名空间中安装 operator,或选择个别命名空间(如果可用),仅在所选命名空间中安装 Operator。
- 更新频道: 如果 EAP operator 可通过多个频道获得,您可以选择要订阅的频道。例如,要通过 stable 频道部署(如果可用),则从列表中选择这个选项。
- 批准策略:您可以选择自动或手动更新。如果选择自动更新 EAP 操作器,则当有新版本 Operator 可用时,Operator Lifecycle Manager(OLM)会自动升级正在运行的 EAP 实例。如果选择手动更新,则当有新版 Operator 可用时,OLM 会创建更新请求。然后,您必须手动批准更新请求,使 Operator 更新至新版本。
以下流程可能会根据 OpenShift Container Platform Web 控制台中的修改而有所变化。有关最新且最准确的步骤,请参阅 OpenShift Container Platform 指南中的使用 Web 控制台从 OperatorHub 安装 部分。
先决条件
-
使用具有
cluster-admin
权限的账户访问 OpenShift Container Platform 集群。
流程
- 在 OpenShift Container Platform Web 控制台中导航至 Operators→ OperatorHub。
-
向下滚动或在 Filter by keyword 框中键入
EAP
,以查找 EAP 操作器。 - 选择 JBoss EAP operator 并单击 Install。
在 Create Operator Subscription 页面:
任选以下一项:
-
All namespaces on the cluster(default),将 operator 安装至默认
openshift-operators
命名空间,以便供集群中的所有命名空间监视和使用。该选项并非始终可用。 - 集群中的特定命名空间会在 您选择的特定单一命名空间中安装 Operator。Operator 仅可在该单一命名空间中使用。
-
All namespaces on the cluster(default),将 operator 安装至默认
- 选择一个 Update Channel。
- 如前面所述,选择自动或手动批准策略。
点击 Subscribe 使 EAP operator 可供 OpenShift Container Platform 集群上的所选命名空间使用。
- 如果选择了手动批准策略,订阅的升级状态将保持在 Upgrading,直至您审核并批准了它的安装计划。在 Install Plan 页面上批准安装计划后,订阅的升级状态将变为 Up to date。
- 如果您选择了一个自动批准策略,则升级状态会在不干预的情况下变为 Up to date。
在订阅的升级状态变为 Up to date 后,选择 Operators → Installed Operators 来验证 EAP ClusterServiceVersion(CSV)是否显示为 up,其 Status 会在相关命名空间中变为 InstallSucceeded。
注意对于 All namespaces… 安装模式,
openshift-operators
命名空间中显示的状态为 InstallSucceeded。在其他命名空间中,显示的状态是 Copied。-
如果 Status 字段没有更改为 InstallSucceeded,请检查
openshift-operators
项目(如果选择了其他相关命名空间)中的 pod 的日志,这会在 Workloads → Pods 页面中报告问题以便进一步排除故障。
7.2. 使用 CLI 安装 EAP Operator
作为 JBoss EAP 集群管理员,您可以使用 OpenShift Container Platform CLI 从 Red Hat OperatorHub 安装 EAP operator。然后,您可以将 EAP operator 订阅至一个或多个命名空间,供集群上的开发人员使用。
使用 CLI 从 OperatorHub 安装 EAP 操作器时,请使用 oc
命令创建 Subscription
对象。
先决条件
-
可以使用具有
cluster-admin
权限的账户访问 OpenShift Container Platform 集群。 -
您已在本地系统中安装了
oc
工具。
流程
查看 OperatorHub 中集群可用的 Operator 列表:
$ oc get packagemanifests -n openshift-marketplace | grep eap NAME CATALOG AGE ... eap Red Hat Operators 43d ...
创建一个
Subscription
对象 YAML 文件(例如,eap-operator-sub.yaml
)来向 EAP operator 订阅命名空间。以下是Subscription
对象 YAML 文件示例:apiVersion: operators.coreos.com/v1alpha1 kind: Subscription metadata: name: eap namespace: openshift-operators spec: channel: stable installPlanApproval: Automatic name: eap 1 source: redhat-operators 2 sourceNamespace: openshift-marketplace
有关频道和批准策略的详情,请查看此流程的 Web 控制台版本。
从 YAML 文件创建
Subscription
对象:$ oc apply -f eap-operator-sub.yaml $ oc get csv -n openshift-operators NAME DISPLAY VERSION REPLACES PHASE eap-operator.v1.0.0 JBoss EAP 1.0.0 Succeeded
EAP 操作器已经安装成功。此时,OLM 知道 EAP 操作器。Operator 的 ClusterServiceVersion(CSV)出现在目标命名空间中,由 EAP 操作器提供的 API 可用于创建。
7.3. 用于创建应用程序镜像的 eap-s2i-build 模板
使用 eap-s2i-build
模板来创建应用镜像。eap-s2i-build
模板添加几个参数来配置应用源存储库的位置,以及用于构建应用的 EAP S2I 镜像。
eap-s2i-build
模板中的 APPLICATION_IMAGE
参数指定与应用镜像对应的镜像流的名称。例如,如果您从 eap-s2i-build
模板创建了名为 my-app
的应用程序镜像,您可以使用 my-app
镜像流中的 my-app:latest
imagestreamtag 来部署应用程序。有关 eap-s2i-build
模板中使用的参数的更多信息,请参阅使用 eap-s2i-build 模板构建应用程序镜像。
借助此模板,EAP 操作员可以无缝地升级 OpenShift 中部署的应用。要启用无缝升级,您必须在 GitHub 仓库中配置 webhook,并在构建配置中指定 webhook。当存储库被更新并触发新构建时,webhook 会通知 OpenShift。
您可以使用此模板为任何 JBoss EAP 版本(如 JBoss EAP 7.4、JBoss EAP XP 或 JBoss EAP CD)使用镜像流构建应用程序镜像。
7.4. 使用 eap-s2i-build 模板构建应用程序镜像
eap-s2i-build
模板添加几个参数来配置应用源存储库的位置,以及用于构建应用的 EAP S2I 镜像。通过此模板,您可以将镜像流用于任何 JBoss EAP 版本,如 JBoss EAP 7.4、JBoss EAP XP 或 JBoss EAP CD。
流程
- 在 OpenShift 中导入 EAP 镜像。如需更多信息,请参阅为 JBoss EAP XP 导入 OpenShift 镜像流和模板。
- 配置镜像流以接收应用镜像流中更改的更新并触发新构建。如需更多信息,请参阅配置定期导入 imagestreamtag。
创建
eap-s2i-build
模板,以使用 EAP S2I 镜像构建应用镜像:$ oc replace --force -f https://raw.githubusercontent.com/jboss-container-images/jboss-eap-openshift-templates/master/eap-s2i-build.yaml
此
eap-s2i-build
模板创建两个构建配置,以及两个与中间构建工件和最终应用程序镜像对应的镜像流。使用参数处理
eap-s2i-build
模板,以创建最终应用镜像的资源。以下示例创建了应用程序镜像my-app
:$ oc process eap-s2i-build \ -p APPLICATION_IMAGE=my-app \ 1 \ -p EAP_IMAGE=jboss-eap-xp1-openjdk11-openshift:1.0 \ 2 -p EAP_RUNTIME_IMAGE=jboss-eap-xp1-openjdk11-runtime-openshift:1.0 \ 3 -p EAP_IMAGESTREAM_NAMESPACE=$(oc project -q) \ 4 \ -p SOURCE_REPOSITORY_URL=https://github.com/jboss-developer/jboss-eap-quickstarts.git \ 5 -p SOURCE_REPOSITORY_REF=xp-1.0.x \ 6 -p CONTEXT_DIR=microprofile-config | oc create -f - 7
使用 EAP 操作器准备应用镜像以进行部署。
配置
WildFlyServer
资源:$ cat > my-app.yaml<<EOF apiVersion: wildfly.org/v1alpha1 kind: WildFlyServer metadata: name: my-app spec: applicationImage: 'my-app:latest' replicas: 1 EOF
应用设置,并让 EAP 操作器创建新的
WildFlyServer
资源来引用此应用镜像:$ oc apply -f my-app.yaml
使用以下命令查看
WildFlyServer
资源:$ oc get wfly my-app
其他资源
- 有关导入应用程序镜像流的更多信息,请参阅为 JBoss EAP XP 导入最新的 OpenShift 镜像流和模板。
- 有关定期导入镜像流的更多信息,请参阅配置定期导入 imagestreamtag。
7.5. 使用 EAP Operator 在 OpenShift 上部署 Java 应用程序
EAP 操作员有助于在 OpenShift 上自动化 Java 应用程序部署。有关 EAP Operator API 的信息,请参阅 EAP Operator: API Information。
先决条件
- 已安装 EAP operator。有关安装 EAP Operator 的更多信息,请参阅使用 Webconsole 安装 EAP Operator 并使用 CLI 安装 EAP Operator。
- 您已使用 JBoss EAP 为 OpenShift Source-to-Image(S2I)构建镜像构建了用户应用的 Docker 镜像。
-
如果要在 OpenShift 上部署后启用应用程序自动升级应用程序,则
eap-s2i-build
模板中的APPLICATION_IMAGE
参数具有镜像流。有关使用eap-s2i-build
模板构建应用程序镜像的更多信息,请参阅使用 eap-s2i-build 模板构建应用程序镜像。 -
如果应用程序的 CustomResourceDefinition(CRD)文件引用了一个
Secret
对象,则已创建了 Secret。有关创建新Secret
对象的更多信息,请参阅创建 Secret。 -
如果您的应用程序的 CRD 文件引用了
ConfigMap
,则已创建了 ConfigMap。有关创建ConfigMap
的信息 ,请参阅创建 ConfigMap。 -
如果选择这样做,则已从
standalone.xml
文件创建了ConfigMap
。有关从standalone.xml
文件创建ConfigMap
的详情,请参考 从 standalone.xml 文件创建 ConfigMap。
JBoss EAP 7 不支持从 ConfigMap
提供 standalone.xml
文件。
流程
- 打开 Web 浏览器并登录到 OperatorHub。
- 选择您要用于 Java 应用程序的 Project 或命名空间。
- 进入到 Installed Operator,再选择 JBoss EAP operator。
- 在 Overview 选项卡中,点 Create Instance 链接。
指定应用程序镜像详情。
应用镜像指定包含 Java 应用的 Docker 镜像。镜像必须使用 OpenShift Source-to-Image(S2I)构建镜像的 JBoss EAP 来构建。如果
applicationImage
字段与 imagestreamtag 对应,则对镜像的任何更改都会触发应用的自动升级。您可以为 OpenShift 应用程序镜像提供以下 JBoss EAP 参考:
- 镜像的名称:mycomp/myapp
- tag: mycomp/myapp:1.0
- A digest: mycomp/myapp:@sha256:0af38bc38be93116b6a1d86a9c78bd14cd527121970899d719baf78e5dc7bfd2
- imagestreamtag: my-app:latest
指定应用程序的大小。例如:
spec: replicas:2
使用
env spec
配置应用程序环境。环境变量可以直接来自值,如 POSTGRESQL_SERVICE_HOST 或来自Secret
对象,如 POSTGRESQL_USER。例如:spec: env: - name: POSTGRESQL_SERVICE_HOST value: postgresql - name: POSTGRESQL_SERVICE_PORT value: '5432' - name: POSTGRESQL_DATABASE valueFrom: secretKeyRef: key: database-name name: postgresql - name: POSTGRESQL_USER valueFrom: secretKeyRef: key: database-user name: postgresql - name: POSTGRESQL_PASSWORD valueFrom: secretKeyRef: key: database-password name: postgresql
完成与应用程序部署相关的以下可选配置:
- 指定服务器数据目录的存储要求。如需更多信息,请参阅为应用程序配置持久性存储。
指定您在
WildFlyServerSpec
中创建的Secret
名称,将其挂载为运行应用的 Pod 中的卷。例如:spec: secrets: - my-secret
Secret
挂载于/etc/secrets/<secret name>
;,每个键/值都存储为一个文件。文件的名称是键,内容是值。Secret
作为一个卷在 pod 中挂载。以下示例演示了可用于查找密钥值的命令:$ ls /etc/secrets/my-secret/ my-key my-password $ cat /etc/secrets/my-secret/my-key devuser $ cat /etc/secrets/my-secret/my-password my-very-secure-pasword
注意修改
Secret
对象可能会导致项目不一致。红帽建议创建一个与旧内容相同的新对象,而不是修改现有的Secret
对象。然后,您可以根据需要更新内容,并将 operator 自定义资源(CR)中的引用从旧改为新的。这被视为一个新的 CR 更新,pod 被重新加载。指定您在
WildFlyServerSpec
中创建的ConfigMap
名称,将其挂载为运行应用的 Pod 中的卷。例如:spec: configMaps: - my-config
ConfigMap
挂载于/etc/configmaps/<configmap name>
;,每个键/值都存储为一个文件。文件的名称是键,内容是值。ConfigMap
作为一个卷在 pod 中挂载。查找键值:$ ls /etc/configmaps/my-config/ key1 key2 $ cat /etc/configmaps/my-config/key1 value1 $ cat /etc/configmaps/my-config/key2 value2
注意修改
ConfigMap
可能会导致项目不一致。红帽建议创建一个与旧内容相同的新ConfigMap
,而不是修改现有ConfigMap
。然后,您可以根据需要更新内容,并将 operator 自定义资源(CR)中的引用从旧改为新的。这被视为一个新的 CR 更新,pod 被重新加载。如果您选择有自己的独立
ConfigMap
,请提供ConfigMap
的名称以及standalone.xml
文件的密钥:standaloneConfigMap: name: clusterbench-config-map key: standalone-openshift.xml
注意JBoss EAP 7 不支持从
standalone.xml
文件创建ConfigMap
。如果要在 OpenShift 中禁用默认 HTTP 路由创建,请将
disableHTTPRoute
设置为true
:spec: disableHTTPRoute: true
7.5.1. 创建 Secret
如果应用的 CustomResourceDefinition(CRD)文件引用 Secret
,则必须在使用 EAP 操作器在 OpenShift 上部署应用程序前创建 Secret
。
流程
-
创建
Secret
:
$ oc create secret generic my-secret --from-literal=my-key=devuser --from-literal=my-password='my-very-secure-pasword'
7.5.2. 创建 ConfigMap
如果应用程序的 CustomResourceDefinition(CRD)文件引用了 spec.ConfigMaps 字段中的 ConfigMap,则必须在使用 EAP 操作器在 OpenShift 上部署应用程序前创建 ConfigMap。
流程
- 创建 configmap:
$ oc create configmap my-config --from-literal=key1=value1 --from-literal=key2=value2 configmap/my-config created
7.5.3. 从 standalone.xml 文件创建 ConfigMap
您可以创建自己的 JBoss EAP 单机配置,而不使用来自 JBoss EAP for OpenShift Source-to-Image(S2I)的应用镜像中的一个。standalone.xml
文件必须放在可由 Operator 访问的 ConfigMap
中。
注意:JBoss EAP 7 不支持从 ConfigMap
中提供 standalone.xml
文件。
流程
-
从
standalone.xml
文件创建ConfigMap
:
$ oc create configmap clusterbench-config-map --from-file examples/clustering/config/standalone-openshift.xml configmap/clusterbench-config-map created
7.5.4. 为应用程序配置持久性存储
如果您的应用程序需要一些数据的持久性存储,如在 pod 重启后必须保留的事务或消息日志,请配置存储规格。如果存储 spec 为空,则应用程序的每个 pod 都会使用 EmptyDir
卷。但是,这个卷在对应的 pod 停止后不会保留。
流程
指定
volumeClaimTemplate
配置资源要求,以存储 JBoss EAP 独立数据目录。模板的名称派生自 JBoss EAP 的名称。对应的卷以ReadWriteOnce
访问模式挂载。spec: storage: volumeClaimTemplate: spec: resources: requests: storage: 3Gi
满足此存储要求的持久性卷挂载到
/eap/standalone/data
目录中。
7.6. 使用 EAP operator 部署启用了 Red Hat Single Sign-On 的镜像
EAP 操作器可帮助您部署在 OpenShift 上启用的红帽单点登录的 EAP 应用镜像。要部署应用程序镜像,请配置表中列出 的环境变量和 secret。
先决条件
- 已安装 EAP 操作器。有关安装 EAP 操作器的更多信息,请参阅使用 Web 控制台安装 EAP 操作器 和 使用 CLI 安装 EAP 操作器。
-
您已使用
eap74-sso-s2i
模板构建 EAP 应用程序镜像。有关构建 EAP 应用镜像的详情,请参考 构建应用程序镜像。
流程
-
从构建 EAP 应用镜像的位置中删除
eap74-sso-s2i
模板创建的DeploymentConfig
文件。 在 EAP 操作器的
WildFlyServer
资源的env
字段中,配置 所有环境变量和机密。配置示例
$ cat > my-app.yaml<<EOF apiVersion: wildfly.org/v1alpha1 kind: WildFlyServer metadata: name: my-app spec: applicationImage: 'my-app:latest' replicas: 1 env: - name: SSO_URL value: https://secure-sso-sso-app-demo.openshift32.example.com/auth - name: SSO_REALM value: eap-demo - name: SSO_PUBLIC_KEY value: realm-public-key - name: SSO_USERNAME value: mySsoUser - name: SSO_PASSWORD value: 6fedmL3P - name: SSO_SAML_KEYSTORE value: /etc/secret/sso-app-secret/keystore.jks - name: SSO_SAML_KEYSTORE_PASSWORD value: mykeystorepass - name: SSO_SAML_CERTIFICATE_NAME value: jboss - name: SSO_BEARER_ONLY value: true - name: SSO_CLIENT value: module-name - name: SSO_ENABLE_CORS value: true - name: SSO_SECRET value: KZ1QyIq4 - name: SSO_DISABLE_SSL_CERTIFICATE_VALIDATION value: true - name: SSO_SAML_KEYSTORE_SECRET value: sso-app-secret - name: HTTPS_SECRET value: eap-ssl-secret - name: SSO_TRUSTSTORE_SECRET value: sso-app-secret EOF
注意- 确保所有环境变量和 secret 都与镜像配置匹配。
-
参数的值
SSO_URL
因 OpenShift 集群的用户而异。 -
EAP 操作器将机密挂载到
/etc/secret
目录中,而eap74-sso
模板会将机密挂载到/etc
目录中。
-
保存 EAP 操作器的
WildFlyServer
资源配置。
7.7. 使用 EAP 操作器查看应用的指标
您可以使用 EAP 操作器查看在 OpenShift 上部署的应用的指标。
当集群管理员在项目中启用指标监控时,EAP operator 会自动显示 OpenShift 控制台上的指标。
先决条件
- 集群管理员已为项目启用了监控功能。如需更多信息,请参阅为用户定义的项目启用监控。
流程
- 在 OpenShift Container Platform Web 控制台中进入 Monitoring→ Metrics。
- 在 Metrics 屏幕上,在文本框中键入应用程序的名称以选择您的应用程序。应用程序的指标会出现在屏幕上。
与 JBoss EAP 应用服务器相关的所有指标都以 jboss
前缀。例如,jboss_undertow_request_count_total
。
7.8. 使用 Web 控制台卸载 EAP Operator
要从集群中删除或卸载 EAP operator,您可以删除订阅,将其从订阅的命名空间中删除。您还可以删除 EAP Operator 的 ClusterServiceVersion(CSV)和部署。
为确保数据一致性和安全,请在卸载 EAP 操作前将集群中的 pod 数量缩减为 0。
您可以使用 Web 控制台卸载 EAP 操作器。
如果您决定删除整个 wildflyserver
定义(oc delete wildflyserver <deployment_name&
gt;),则没有启动事务恢复过程,无论未完成的事务如何终止 pod。从此操作导致的未完成工作可能会阻止您随后启动的数据更改。其他涉及事务性企业所涉及的 JBoss EAP 实例的数据变化也会被利用这个 wildflyserver
进行远程调用。
流程
- 在 Operators→ Installed Operators 页面中,选择 JBoss EAP。
- 在 Operator Details 页面的右侧,从 Actions 下拉菜单中选择 Uninstall Operator。
- 如果要删除所有安装相关组件,则在看到 Remove Operator Subscription 窗口提示时,勾选 Also completely remove the Operator from the selected namespace 复选框。这会删除 CSV,并删除与 Operator 关联的 pod、部署、自定义资源定义(CRD)和自定义资源(CR)。
- 单击 Remove。EAP 操作器将停止运行,并且不再接收更新。
7.9. 使用 CLI 卸载 EAP Operator
要从集群中删除或卸载 EAP operator,您可以删除订阅,将其从订阅的命名空间中删除。您还可以删除 EAP Operator 的 ClusterServiceVersion(CSV)和部署。
为确保数据一致性和安全,请在卸载 EAP 操作前将集群中的 pod 数量缩减为 0。
您可以使用命令行卸载 EAP 操作器。
使用命令行时,您可以通过从目标命名空间中删除订阅和 CSV 来卸载 Operator。
如果您决定删除整个 wildflyserver
定义(oc delete wildflyserver <deployment_name&
gt;),则没有启动事务恢复过程,无论未完成的事务如何终止 pod。从此操作导致的未完成工作可能会阻止您随后启动的数据更改。其他涉及事务性企业所涉及的 JBoss EAP 实例的数据变化也会被利用这个 wildflyserver
进行远程调用。
流程
在
currentCSV
字段中检查 EAP operator 订阅的当前版本:$ oc get subscription eap-operator -n openshift-operators -o yaml | grep currentCSV currentCSV: eap-operator.v1.0.0
删除 EAP Operator 的订阅:
$ oc delete subscription eap-operator -n openshift-operators subscription.operators.coreos.com "eap-operator" deleted
使用上一步中的
currentCSV
值删除目标命名空间中 EAP Operator 的 CSV:$ oc delete clusterserviceversion eap-operator.v1.0.0 -n openshift-operators clusterserviceversion.operators.coreos.com "eap-operator.v1.0.0" deleted
7.10. 用于安全事务恢复的 EAP Operator
对于特定类型的事务,EAP 操作器会在终止应用程序集群前确保数据一致性,方法是验证所有事务在缩减副本前完成,并将 pod 标记为 clean
用于终止。
一些环境不被支持。有关不支持的场景的更多信息,请参阅不支持的事务恢复方案。
这意味着,如果要安全地删除部署时没有数据不一致,您必须首先将 pod 数量缩减为 0,等待所有 pod 终止,然后只删除 wildflyserver
实例。
如果您决定删除整个 wildflyserver
定义(oc delete wildflyserver <deployment_name&
gt;),则没有启动事务恢复过程,无论未完成的事务如何终止 pod。从此操作导致的未完成工作可能会阻止您随后启动的数据更改。其他涉及事务性企业所涉及的 JBoss EAP 实例的数据变化也会被利用这个 wildflyserver
进行远程调用。
当 scaledown 进程启动 pod 状态(oc get pod <pod_name>
)仍标记为 Running
,因为 pod 必须完成所有未完成的事务,包括针对该目标的远程企业级 Bean 调用。
如果要监控 scaledown 进程的状态,请观察 wildflyserver
实例的状态。如需更多信息,请参阅监控扩展进程。有关缩减期间 pod 状态的信息,请参阅在扩展过程中 Pod 状态。
7.10.1. Stable Network Host Names 的 StatefulSets
管理 wildflyserver 的 EAP operator 将创建一个 StatefulSet
作为管理 JBoss EAP pod 的底层对象。
StatefulSet
是管理有状态应用程序的工作负载 API 对象。它管理一组 pod 的部署和扩展,并为这些 pod 的排序和唯一性提供保证。
StatefulSet
确保集群中的 pod 以预定义的顺序命名。它还确保 pod 终止遵循相同的顺序。例如,pod-1 有一个交易的结果,因此处于 SCALING_DOWN_RECOVERY_DIRTY
状态。即使 pod-0 处于 SCALING_DOWN_CLEAN
状态,它也不会在 pod-1 前终止。在 pod-1 干净
且被终止前,pod-0 会一直处于 SCALING_DOWN_CLEAN
状态。但是,即使 pod-0 处于 SCALING_DOWN_CLEAN
状态,它也不会收到任何新请求,且闲置实际。
减少 StatefulSet
的副本大小或删除 pod 本身无效,并会恢复此类更改。
7.10.2. 监控扩展过程
如果要监控 scaledown 进程的状态,您必须观察 wildflyserver
实例的状态。有关 scaledown 期间不同 pod 状态的更多信息,请参阅在扩展过程中 Pod 状态。
流程
观察 scaledown 进程的状态:
oc describe wildflyserver <name>
- WildFlyServer.Status.Scaling Pods 和 WildFlyServer.Status.Replicas 字段显示了主动和非活跃 pod 的整体状态。
- Scalingdown Pods 字段显示所有未完成事务完成后要被终止的 pod 数量。
- WildFlyServer.Status.Replicas 字段显示当前运行的 pod 数量。
- WildFlyServer.Spec.Replicas 字段显示处于 ACTIVE 状态的 pod 数量。
- 如果没有 pod 缩减,则处理 WildFlyServer.Status.Replicas 和 WildFlyServer.Spec.Replicas 字段中的 pod 数量相等。
7.10.2.1. 缩放期间的 Pod 状态
下表描述了 scaledown 期间的不同 pod 状态:
表 7.1. Pod 状态描述
Pod 状态 | 描述 |
---|---|
ACTIVE | pod 处于活跃状态并处理请求。 |
SCALING_DOWN_RECOVERY_INVESTIGATION | pod 即将缩减。缩减流程正在调查 JBoss EAP 中的事务状态。 |
SCALING_DOWN_RECOVERY_DIRTY | JBoss EAP 包含一些不完整的事务。pod 无法被终止,直到被清理为止。事务恢复过程定期在 JBoss EAP 上运行,它会等到事务完成 |
SCALING_DOWN_CLEAN |
pod 由事务缩减处理处理,并标记为要从集群中删除的 |
7.10.3. 使用 Heuristic Outcomes 在交易期间缩减
当事务的结果未知时,无法进行自动事务恢复。然后,您必须手动恢复您的事务。
先决条件
-
您的 pod 的状态一直处于
SCALING_DOWN_RECOVERY_DIRTY
中。
流程
- 使用 CLI 访问您的 JBoss EAP 实例。
- 解决事务对象存储中的所有 Heuristics 事务记录。如需更多信息,请参阅 JBoss EAP 管理事务中的恢复 Heuristic Outcomes。
从企业 bean 客户端恢复文件夹中删除所有记录。
从 pod enterprise bean 客户端恢复目录中删除所有文件:
$JBOSS_HOME/standalone/data/ejb-xa-recovery oc exec <podname> rm -rf $JBOSS_HOME/standalone/data/ejb-xa-recovery
-
您的 Pod 的状态会变为
SCALING_DOWN_CLEAN
且 pod 终止。
7.10.4. 配置 transactions 子系统,以使用 JDBC 存储进行事务日志
如果系统不提供文件系统来存储 事务日志
,请使用 JBoss EAP S2I 镜像来配置 JDBC 对象存储。
当 JBoss EAP 部署为可引导 JAR 时,S2I 环境变量不可用。在这种情况下,您必须创建一个 Galleon 层或配置 CLI 脚本来进行必要的配置更改。
JDBC 对象存储可使用环境变量 TX_DATABASE_PREFIX_MAPPING
设置。此变量具有与 DB_SERVICE_PREFIX_MAPPING
相同的结构。
前提条件
- 您已根据环境变量的值创建了数据源。
-
您保证了一致的数据读写权限在数据库与 JDBC 对象存储通信
的事务管理器
之间存在。如需更多信息,请参阅配置 JDBC 数据源
流程
通过 S2I 环境变量设置和配置 JDBC 对象存储。
示例
# Narayana JDBC objectstore configuration via s2i env variables - name: TX_DATABASE_PREFIX_MAPPING value: 'PostgresJdbcObjectStore-postgresql=PG_OBJECTSTORE' - name: POSTGRESJDBCOBJECTSTORE_POSTGRESQL_SERVICE_HOST value: 'postgresql' - name: POSTGRESJDBCOBJECTSTORE_POSTGRESQL_SERVICE_PORT value: '5432' - name: PG_OBJECTSTORE_JNDI value: 'java:jboss/datasources/PostgresJdbc' - name: PG_OBJECTSTORE_DRIVER value: 'postgresql' - name: PG_OBJECTSTORE_DATABASE value: 'sampledb' - name: PG_OBJECTSTORE_USERNAME value: 'admin' - name: PG_OBJECTSTORE_PASSWORD value: 'admin'
验证
您可以通过检查
standalone-openshift.xml
配置文件oc rsh <podname> cat /opt/eap/standalone/configuration/standalone-openshift.xml
来验证数据源配置和事务子系统配置。预期输出:
<datasource jta="false" jndi-name="java:jboss/datasources/PostgresJdbcObjectStore" pool-name="postgresjdbcobjectstore_postgresqlObjectStorePool" enabled="true" use-java-context="true" statistics-enabled="${wildfly.datasources.statistics-enabled:${wildfly.statistics-enabled:false}}"> <connection-url>jdbc:postgresql://postgresql:5432/sampledb</connection-url> <driver>postgresql</driver> <security> <user-name>admin</user-name> <password>admin</password> </security> </datasource> <!-- under subsystem urn:jboss:domain:transactions --> <jdbc-store datasource-jndi-name="java:jboss/datasources/PostgresJdbcObjectStore"> <!-- the pod name was named transactions-xa-0 --> <action table-prefix="ostransactionsxa0"/> <communication table-prefix="ostransactionsxa0"/> <state table-prefix="ostransactionsxa0"/> </jdbc-store>
其他资源
- 有关使用管理控制台或管理 CLI 创建数据源的更多信息,请参阅 JBoss EAP 配置指南中的创建数据源。
7.11. 使用 pod 横向自动扩展 HPA 自动扩展 pod
通过 EAP 操作器,您可以使用 pod 横向自动扩展 HPA 根据从属于该 EAP 应用的 pod 收集的指标自动增加或减少 EAP 应用缩放。
使用 HPA 可确保在 pod 缩减时仍然处理事务恢复。
流程
配置资源:
apiVersion: wildfly.org/v1alpha1 kind: WildFlyServer metadata: name: eap-helloworld spec: applicationImage: 'eap-helloworld:latest' replicas: 1 resources: limits: cpu: 500m memory: 2Gi requests: cpu: 100m memory: 1Gi
重要您必须为 pod 中的容器指定资源限值和请求,以便自动扩展才能按预期工作。
创建 Horizontal pod 自动缩放器:
oc autoscale wildflyserver/eap-helloworld --cpu-percent=50 --min=1 --max=10
验证
- 您可以通过检查副本来验证 HPA 行为。副本数量会根据工作负载的增加或减少而进行相应的增加或减少。
oc get hpa -w NAME REFERENCE TARGETS MINPODS MAXPODS REPLICAS AGE eap-helloworld WildFlyServer/eap-helloworld 217%/50% 1 10 1 4s eap-helloworld WildFlyServer/eap-helloworld 217%/50% 1 10 4 17s eap-helloworld WildFlyServer/eap-helloworld 133%/50% 1 10 8 32s eap-helloworld WildFlyServer/eap-helloworld 133%/50% 1 10 10 47s eap-helloworld WildFlyServer/eap-helloworld 139%/50% 1 10 10 62s eap-helloworld WildFlyServer/eap-helloworld 180%/50% 1 10 10 92s eap-helloworld WildFlyServer/eap-helloworld 133%/50% 1 10 10 2m2s
7.12. Jakarta Enterprise Beans on OpenShift 的 Remoting
要使 JBoss EAP 能够在 OpenShift 上的不同 JBoss EAP 集群之间正确地使用企业 bemoting 调用,您必须了解 OpenShift 上的企业 bean remoting 配置选项。
在 OpenShift 上部署时,请考虑使用 EAP 操作器。EAP 操作员使用 StatefulSet
来处理企业 bean remoting 和事务恢复处理。StatefulSet
确保持久性存储和网络主机名稳定性,即使 pod 重启后也是如此。
使用企业级 bean 远程调用和事务传播联系时,需要网络主机名稳定性。即使 pod 重启,OpenShift EAP 实例也必须在相同的主机名下访问。事务管理器(一个有状态组件)将持久的事务数据绑定到特定的 JBoss EAP 实例。由于事务日志绑定到特定的 JBoss EAP 实例,它必须在同一实例中完成。
要在使用 JDBC 事务日志存储时防止数据丢失,请确保您的数据库提供了数据一致性的读取和写入。当数据库通过多个实例水平扩展时,一致的数据读取和写入非常重要。
企业 bean 远程调用者有两个选项来配置远程调用:
- 定义远程出站连接。如需更多信息,请参阅配置远程出站连接。
- 对远程服务器中的 bean 使用编程 JNDI 查找。如需更多信息,请参阅使用远程 Jakarta Enterprise Beans 客户端。
您必须根据企业 bean 远程调用配置方法重新配置代表目标节点地址的值。
远程调用的目标企业级名称必须是第一个 pod 的 DNS 地址。
StatefulSet
的行为取决于 pod 的排序。pod 以预定义的顺序命名。例如,如果您将应用扩展到三个副本,您的 pod 的名称为 eap-server-0
、eap-server-1
和 eap-server-2
。
EAP 操作器也使用 无头服务 来确保特定的 DNS 主机名被分配给 pod。如果应用使用 EAP 操作器,则使用名称(如 eap-server-headless
)创建一个无头服务。在本例中,第一个 pod 的 DNS 名称为 eap-server-0.eap-server-headless
。
使用 hostname eap-server-0.eap-server-headless
可确保企业 bean 调用到达连接到集群的任何 EAP 实例。bootstrap 连接用于初始化 Jakarta Enterprise Beans 客户端,它将 EAP 集群的结构收集为下一步。
7.12.1. 在 OpenShift 上配置 Jakarta Enterprise Beans
您必须配置作为企业级补救的调用者的 JBoss EAP 服务器。目标服务器必须配置有权限的用户,才能接收企业 bean 远程调用。
先决条件
- 您已使用 EAP 操作器和支持的 OpenShift S2I 镜像,用于在 OpenShift 中部署和管理 JBoss EAP 应用实例。
- 集群设置正确。有关 JBoss EAP 集群的更多信息,请参阅集群部分。
流程
在目标服务器上创建一个用户,并有权接收企业 bean 远程调用:
$JBOSS_HOME/bin/add-user.sh
配置调用 JBoss EAP 应用服务器。
-
使用自定义配置功能,在
$JBOSS_HOME/standalone/configuration
中创建eap-config.xml
文件。如需更多信息,请参阅 自定义配置。 使用
wildfly.config.url
属性配置调用器 JBoss EAP 应用服务器:JAVA_OPTS_APPEND="-Dwildfly.config.url=$JBOSS_HOME/standalone/configuration/eap-config.xml"
注意如果您的配置使用以下示例,请将
>>PASTE_…_HERE<<
替换为您配置的用户名和密码。配置示例
<configuration> <authentication-client xmlns="urn:elytron:1.0"> <authentication-rules> <rule use-configuration="jta"> <match-abstract-type name="jta" authority="jboss" /> </rule> </authentication-rules> <authentication-configurations> <configuration name="jta"> <sasl-mechanism-selector selector="DIGEST-MD5" /> <providers> <use-service-loader /> </providers> <set-user-name name="PASTE_USER_NAME_HERE" /> <credentials> <clear-password password="PASTE_PASSWORD_HERE" /> </credentials> <set-mechanism-realm name="ApplicationRealm" /> </configuration> </authentication-configurations> </authentication-client> </configuration>
-
使用自定义配置功能,在
第 8 章 参考信息
本节中的内容派生自此镜像的工程文档。它仅供参考,因为它可用于开发目的,并在产品文档的讨论范围之外进行测试。
8.1. 持久性模板
部署 JBoss EAP 和数据库 pod 的 JBoss EAP 数据库模板具有临时和持久变化。
永久模板包含环境变量以调配持久卷声明,它将与可用持久卷绑定,用作 OpenShift 部署的存储卷。计时器架构、日志处理或数据更新等信息存储在存储卷上,而不是存储在临时容器内存中。如果 pod 因任何原因而停机,则此信息会被保留,如项目升级、部署回滚或意外错误。
如果没有用于部署的持久性存储卷,这些信息只存储在容器内存中,并在 pod 因任何原因而停机时丢失。
例如,如果 pod 重新启动,由持久性存储支持的 EE 计时器会继续运行。当应用程序再次运行时,计时器在重启过程中触发的任何事件都会被激活。
相反,如果 EE 计时器在容器内存中运行,如果 Pod 重新启动,计时器状态将丢失,并且从 pod 再次运行时启动。
8.2. 信息环境变量
以下环境变量旨在向镜像提供信息,且不应由用户修改:
表 8.1. 信息环境变量
变量名称 | 描述和值 |
---|---|
JBOSS_IMAGE_NAME | 镜像名称。 Values:
|
JBOSS_IMAGE_VERSION | 镜像版本。 值:镜像版本号。如需了解最新值,请参阅 Red Hat Container Catalog: |
JBOSS_MODULES_SYSTEM_PKGS | 以逗号分隔的 JBoss EAP 系统模块软件包列表,供应用程序使用。
Value: |
STI_BUILDER |
为
Value: |
8.3. 配置环境变量
您可以配置以下环境变量来调整镜像,而无需重新构建镜像。
有关此处未列出的其他环境变量,请参阅 JBoss EAP 文档。
表 8.2. 配置环境变量
变量名称 | 描述 |
---|---|
AB_JOLOKIA_AUTH_OPENSHIFT |
切换到 OpenShift TLS 通信的客户端身份验证。此参数的值可以是
|
AB_JOLOKIA_CONFIG | 如果设置,请将此完全限定的文件路径用于 Jolokia JVM 代理属性,如 Jolokia 参考文档中所述。如果您设置了自己的 Jolokia 属性配置文件,则忽略本文档中的 Jolokia 设置。
如果没有设置,则使用 Jolokia 参考文档中定义的设置创建
示例值: |
AB_JOLOKIA_DISCOVERY_ENABLED | 启用 Jolokia 发现。
默认值为 |
AB_JOLOKIA_HOST | 要绑定到的主机地址。
默认为
示例值: |
AB_JOLOKIA_HTTPS | 切换到与 HTTPS 的安全通信。
默认情况下,如果在
示例值: |
AB_JOLOKIA_ID | 要使用的代理 ID。
默认值为
示例值: |
AB_JOLOKIA_OFF |
如果设置为 Jolokia 默认启用。 |
AB_JOLOKIA_OPTS |
要附加到代理配置的额外选项。它们应该以
示例值: |
AB_JOLOKIA_PASSWORD | 基本身份验证的密码。 默认情况下,身份验证将被关闭。
示例值: |
AB_JOLOKIA_PASSWORD_RANDOM |
确定是否应该生成随机
设置为 |
AB_JOLOKIA_PORT | 要侦听的端口。
默认为
示例值: |
AB_JOLOKIA_USER | 用于基本身份验证的用户名。
默认为
示例值: |
AB_PROMETHEUS_ENABLE |
如果设为 注意 MicroProfile 指标子系统是以 Prometheus 格式公开数据的首选方法。有关 MicroProfile 指标 susbsystem 的更多信息,请参阅 JBoss EAP 配置指南中的 Eclipse MicroProfile。 |
AB_PROMETHEUS_JMX_EXPORTER_CONFIG |
容器中的路径指向 |
AB_PROMETHEUS_JMX_EXPORTER_PORT |
|
CLI_GRACEFUL_SHUTDOWN |
如果设置为任何非零长度值,则镜像可防止使用
示例值: |
CONTAINER_HEAP_PERCENT | 将最大 Java 堆大小设置为可用容器内存的百分比。
示例值: |
CUSTOM_INSTALL_DIRECTORIES | 在 S2I 过程中用于安装和配置镜像的工件的目录列表。
示例值: |
DEFAULT_JMS_CONNECTION_FACTORY |
此值用于为 Jakarta Messaging 连接工厂指定默认 JNDI 绑定,如
示例值: |
DISABLE_EMBEDDED_JMS_BROKER | 在 OpenShift 容器中使用嵌入的消息传递代理已被弃用。以后的发行版本中会删除对嵌入式代理的支持。 如果以下条件为 true,则会记录一个警告。
如果这个变量包含在设置为
对于没有配置远程消息传递目的地的容器,请将这个变量设为 |
ENABLE_ACCESS_LOG | 启用对标准输出频道的访问信息。 访问消息的日志记录是通过以下方法实现的:
默认值为 |
INITIAL_HEAP_PERCENT | 将初始 Java 堆大小设置为最大堆大小的百分比。
示例值: |
JAVA_OPTS_APPEND | 服务器启动选项。
示例值: |
JBOSS_MODULES_SYSTEM_PKGS_APPEND |
以逗号分隔的软件包名称列表,该名称将附加到
示例值: |
JGROUPS_CLUSTER_PASSWORD |
用于验证节点的密码,以便可以加入 JGroups 集群。必需,在使用
示例值: |
JGROUPS_ENCRYPT_KEYSTORE |
在使用
示例值 |
JGROUPS_ENCRYPT_KEYSTORE_DIR |
在使用
示例值: |
JGROUPS_ENCRYPT_NAME |
使用
值示例: |
JGROUPS_ENCRYPT_PASSWORD |
使用
示例值: |
JGROUPS_ENCRYPT_PROTOCOL |
JGroups 协议用于加密集群流量。可以是
默认为
示例值: |
JGROUPS_ENCRYPT_SECRET |
使用
示例值: |
JGROUPS_PING_PROTOCOL |
用于节点发现的 JGroups 协议。可以是 |
MQ_SIMPLE_DEFAULT_PHYSICAL_DESTINATION |
为了向后兼容,设置为 |
OPENSHIFT_DNS_PING_SERVICE_NAME | 服务的名称会在服务器上公开用于 DNS 发现机制的 ping 端口。
示例值: |
OPENSHIFT_DNS_PING_SERVICE_PORT |
DNS 发现机制的 ping 端口的端口号。如果没有指定,则会尝试从服务的 SRV 记录中发现端口号,否则使用默认的
默认为 |
OPENSHIFT_KUBE_PING_LABELS | 为 Kubernetes 发现机制集群标签选择器。
示例值: |
OPENSHIFT_KUBE_PING_NAMESPACE | 为 Kubernetes 发现机制集群项目命名空间。
示例值: |
SCRIPT_DEBUG |
如果设置为 |
8.4. 应用程序模板
表 8.3. 应用程序模板
变量名称 | 描述 |
---|---|
AUTO_DEPLOY_EXPLODED | 控制是否应该自动部署展开的部署内容。
示例值: |
8.5. 公开端口
表 8.4. 公开端口
端口号 | 描述 |
---|---|
8443 | HTTPS |
8778 | Jolokia Monitoring |
8.6. datasources
datasources 根据某些环境变量的值自动创建。
最重要的环境变量是 DB_SERVICE_PREFIX_MAPPING
,因为它定义了数据源的 JNDI 映射。这个变量允许的值是以逗号分隔的 POOLNAME-DATABASETYPE=PREFIX
triplets 列表,其中:
-
POOLNAME
用作数据源中的pool-name
。 -
DATABASETYPE
是要使用的数据库驱动程序。 -
PREFIX
是用于配置数据源的环境变量名称中使用的前缀。
8.6.1. Datasources 的 JNDI 映射
对于每个 POOLNAME-DATABASETYPE=PREFIX
triplet,在 DB_SERVICE_PREFIX_MAPPING
环境变量中定义,启动脚本会创建一个单独的数据源,在运行镜像时执行。
DB_SERVICE_PREFIX_MAPPING
的第一个部分(前面号)应为小写。
DATABASETYPE
决定数据源的驱动程序。
有关配置驱动程序的更多信息,请参阅 模块、驱动程序和通用部署。JDK 8 镜像具有 postgresql
和 mysql
的驱动程序。
不要将任何特殊字符用于 POOLNAME
参数。
对使用带有 JBoss EAP 的红帽提供的内部数据源驱动程序的支持现已弃用。红帽建议将 JDBC 驱动程序从数据库厂商获取用于 JBoss EAP 应用程序。
JBoss EAP for OpenShift 镜像不再提供以下内部数据源:
- MySQL
- PostgreSQL
有关安装驱动程序的更多信息,请参阅模块、驱动程序和通用部署。
有关使用 JBoss EAP 配置 JDBC 驱动程序的更多信息,请参阅 JBoss EAP 配置指南中的 JDBC 驱动程序。
请注意,如果您想要将它们添加到置备的服务器,您也可以创建一个自定义层来安装这些驱动程序和数据源。
8.6.1.1. 数据源配置环境变量
要配置其他数据源属性,请使用以下环境变量:
务必将以下变量名称中的 POOLNAME
、DATABASETYPE
和 PREFIX
的值替换为适当的值。本节和 Datasources 部分介绍了这些可替换的值。
变量名称 | 描述 |
---|---|
POOLNAME_DATABASETYPE_SERVICE_HOST |
定义要在数据源的
示例值 |
POOLNAME_DATABASETYPE_SERVICE_PORT | 定义数据源的数据库服务器的端口。
示例值: |
PREFIX_BACKGROUND_VALIDATION |
当设置为 |
PREFIX_BACKGROUND_VALIDATION_MILLIS |
当启用 |
PREFIX_CONNECTION_CHECKER | 指定连接检查器类,用于验证正在使用的特定数据库的连接。
示例值: |
PREFIX_DATABASE | 定义数据源的数据库名称。
示例值: |
PREFIX_DRIVER | 为数据源定义 Java 数据库驱动程序。
示例值: |
PREFIX_EXCEPTION_SORTER | 指定异常排序器类,用于在致命的数据库连接异常后正确检测和清理。
示例值: |
PREFIX_JNDI |
定义数据源的 JNDI 名称。默认为
示例值: |
PREFIX_JTA | 为非 XA 数据源定义 Jakarta Transactions 选项。XA datasources 已默认已经支持 Jakarta 事务。
默认值为 |
PREFIX_MAX_POOL_SIZE | 定义数据源的最大池大小选项。
示例值 |
PREFIX_MIN_POOL_SIZE | 定义数据源的最小池大小选项。
示例值: |
PREFIX_NONXA |
将数据源定义为非 XA 数据源。默认值为 |
PREFIX_PASSWORD | 定义数据源的密码。
示例值: |
PREFIX_TX_ISOLATION | 为数据源定义 java.sql.Connection 事务隔离级别。
示例值:TRA |
前缀_URL | 定义数据源的连接 URL。
示例值: |
PREFIX_USERNAME | 定义数据源的用户名。
示例值: |
在 OpenShift 中运行此镜像时,POOLNAME_DATABASETYPE_SERVICE
环境变量会自动从 OpenShift 应用模板中的数据库服务定义设置,而其他项在模板下的容器定义中直接配置为 _HOST
和POOLNAME_DATABASETYPE_SERVICE_PORTenv
条目。
8.6.1.2. 例子
这些示例演示了 DB_SERVICE_PREFIX_MAPPING
环境变量创建的值如何影响数据源创建。
8.6.1.2.1. 单一映射
考虑 test-postgresql=TEST
值。
这会创建一个数据源,其名称为 java:jboss/datasources/test_postgresql
。此外,所有所需的设置(如 password 和 username)都应作为带有 TEST_
prefix 的环境变量提供,如 TEST_USERNAME
和 TEST_PASSWORD
。
8.6.1.2.2. 多个映射
您可以指定多个数据源映射。
始终使用逗号分隔多个数据源映射。
请考虑 DB_SERVICE_PREFIX_MAPPING
环境变量的以下值: cloud-postgresql=CLOUD,test-mysql=TEST_MYSQL
。
这会创建两个数据源:
-
java:jboss/datasources/test_mysql
-
java:jboss/datasources/cloud_postgresql
然后,您可以使用 TEST_MYSQL
前缀来配置 MySQL 数据源的用户名和密码,如 TEST_MYSQL_USERNAME
。对于 PostgreSQL 数据源,请使用 CLOUD_
前缀,如 CLOUD_USERNAME
。
8.7. 集群
8.7.1. 配置 JGroups Discovery Mechanism
要在 OpenShift 上启用 JBoss EAP 集群,请将 JBoss EAP 配置中的Groups 协议堆栈配置为使用 kubernetes.KUBE_PING
或 dns.DNS_PING
发现机制。
虽然您可以使用自定义 standalone-openshift.xml
配置文件,但建议您使用环境变量在镜像构建中配置 JGroups。
以下说明使用环境变量为 OpenShift 镜像配置 JBoss EAP 的发现机制。
如果您使用其中一个可用的应用程序模板在用于 OpenShift 镜像的 JBoss EAP 上部署应用程序,则默认发现机制为 dns.DNS_PING
。
dns.DNS_PING
和 kubernetes.KUBE_PING
发现机制相互兼容。无法组成两个独立子集群的超集群,使用 dns.DNS_PING
机制进行发现,另一个使用 kubernetes.KUBE_PING
机制。同样,当执行滚动升级时,源和目标集群的发现机制需要相同。
8.7.1.1. 配置 KUBE_PING
使用 KUBE_PING
JGroups 发现机制:
JGroups 协议堆栈必须配置为使用
KUBE_PING
作为发现机制。您可以将
JGROUPS_PING_PROTOCOL
环境变量设置为kubernetes.KUBE_PING
:JGROUPS_PING_PROTOCOL=kubernetes.KUBE_PING
KUBERNETES_NAMESPACE
环境变量必须设置为 OpenShift 项目名称。如果没有设置,则服务器的行为为一个单节点集群(一个"集群")。例如:KUBERNETES_NAMESPACE=PROJECT_NAME
应设置
KUBERNETES_LABELS
环境变量。这应当 与服务级别 中设置的标签匹配。如果没有设置,则应用程序外部的 pod(位于您的命名空间中)将尝试加入。例如:KUBERNETES_LABELS=application=APP_NAME
必须授权授予在 下运行 Pod 的服务帐户,以允许访问 Kubernetes 的 REST API。这可通过 OpenShift CLI 完成。以下示例使用当前项目命名空间中的
default
服务帐户:oc policy add-role-to-user view system:serviceaccount:$(oc project -q):default -n $(oc project -q)
在项目命名空间中使用
eap-service-account
:oc policy add-role-to-user view system:serviceaccount:$(oc project -q):eap-service-account -n $(oc project -q)
注意如需有关向服务帐户添加策略的更多信息,请参阅为 应用程序部署准备 OpenShift。
8.7.1.2. 配置 DNS_PING
使用 DNS_PING
JGroups 发现机制:
JGroups 协议堆栈必须配置为使用
DNS_PING
作为发现机制。您可以将
JGROUPS_PING_PROTOCOL
环境变量设置为dns.DNS_PING
:JGROUPS_PING_PROTOCOL=dns.DNS_PING
OPENSHIFT_DNS_PING_SERVICE_NAME
环境变量必须设置为集群的 ping 服务名称。OPENSHIFT_DNS_PING_SERVICE_NAME=PING_SERVICE_NAME
OPENSHIFT_DNS_PING_SERVICE_PORT
环境变量应设置为公开 ping 服务的端口号。DNS_PING
协议尝试从 SRV 记录中识别端口,否则默认为8888
。OPENSHIFT_DNS_PING_SERVICE_PORT=PING_PORT
必须定义公开 ping 端口的 ping 服务。这个服务应该是无头(ClusterIP=None),且必须具有以下内容:
- 端口必须命名为。
该服务必须注解为
service.alpha.kubernetes.io/tolerate-unready-endpoints
和publishNotReadyAddresses
属性,两者均设置为true
。注意-
使用
service.alpha.kubernetes.io/tolerate-unready-endpoints
和publishNotReadyAddresses
属性来确保 ping 服务在两个更新的 OpenShift 版本中正常工作。 - 省略这些注解会导致每个节点在启动过程中组成自己的"集群"。然后,每个节点会在启动时将其集群合并到其他节点的集群,因为其他节点在启动后不会检测到它们。
kind: Service apiVersion: v1 spec: publishNotReadyAddresses: true clusterIP: None ports: - name: ping port: 8888 selector: deploymentConfig: eap-app metadata: name: eap-app-ping annotations: service.alpha.kubernetes.io/tolerate-unready-endpoints: "true" description: "The JGroups ping port for clustering."
-
使用
DNS_PING
不需要对服务帐户进行任何修改,并使用默认权限工作。
8.7.2. 配置 JGroups 以加密集群流量
要在 OpenShift 上为 JBoss EAP 加密集群流量,您必须在 JBoss EAP 配置中配置 JGroups 协议堆栈,以使用 SYM_ENCRYPT
或 ASYM_ENCRYPT
协议。
虽然您可以使用自定义 standalone-openshift.xml
配置文件,但建议您使用环境变量在镜像构建中配置 JGroups。
以下说明使用环境变量来配置用于 OpenShift 镜像的 JBoss EAP 集群流量加密的协议。
SYM_ENCRYPT
和 ASYM_ENCRYPT
协议不相互兼容。无法将超级集群从两个独立的子集群组成,并有一个使用 SYM_ENCRYPT
协议加密集群流量,然后使用 ASYM_ENCRYPT
协议。同样,当执行滚动升级时,源和目标集群的协议需要相同。
8.7.2.1. Configuring SYM_ENCRYPT
使用 SYM_ENCRYPT
协议加密 JGroups 集群流量:
JGroups 协议堆栈必须配置为使用
SYM_ENCRYPT
作为加密协议。您可以将
JGROUPS_ENCRYPT_PROTOCOL
环境变量设置为SYM_ENCRYPT
:JGROUPS_ENCRYPT_PROTOCOL=SYM_ENCRYPT
JGROUPS_ENCRYPT_SECRET
环境变量必须设置为包含用于保护 JGroups 通讯的机密名称。如果没有设置,集群通信不会加密,并发出警告。例如:JGROUPS_ENCRYPT_SECRET=eap7-app-secret
JGROUPS_ENCRYPT_KEYSTORE_DIR
环境变量必须设置为通过JGROUPS_ENCRYPT_SECRET
变量指定的 secret 中密钥存储文件的目录路径。如果没有设置,集群通信不会加密,并发出警告。例如:JGROUPS_ENCRYPT_KEYSTORE_DIR=/etc/jgroups-encrypt-secret-volume
JGROUPS_ENCRYPT_KEYSTORE
环境变量必须设置为通过JGROUPS_ENCRYPT_SECRET
变量指定的 secret 内的密钥存储文件的名称。如果没有设置,集群通信不会加密,并发出警告。例如:JGROUPS_ENCRYPT_KEYSTORE=jgroups.jceks
JGROUPS_ENCRYPT_NAME
环境变量必须设置为与服务器证书关联的名称。如果没有设置,集群通信不会加密,并发出警告。例如:JGROUPS_ENCRYPT_NAME=jgroups
JGROUPS_ENCRYPT_PASSWORD
环境变量必须设置为用于访问密钥存储和证书的密码。如果没有设置,集群通信不会加密,并发出警告。例如:JGROUPS_ENCRYPT_PASSWORD=mypassword
8.7.2.2. Configuring ASYM_ENCRYPT
JBoss EAP 7.4 包含 ASYM_ENCRYPT
协议的新版本。以前版本的协议已弃用。如果指定了 JGROUPS_CLUSTER_PASSWORD
环境变量,则会使用已弃用的协议版本,并在 pod 日志中打印警告。
要使用 ASYM_ENCRYPT
协议加密 JGroups 集群流量,请指定 ASYM_ENCRYPT
作为加密协议,并将它配置为使用 elytron
子系统中配置的密钥存储。
-e JGROUPS_ENCRYPT_PROTOCOL="ASYM_ENCRYPT" \ -e JGROUPS_ENCRYPT_SECRET="encrypt_secret" \ -e JGROUPS_ENCRYPT_NAME="encrypt_name" \ -e JGROUPS_ENCRYPT_PASSWORD="encrypt_password" \ -e JGROUPS_ENCRYPT_KEYSTORE="encrypt_keystore" \ -e JGROUPS_CLUSTER_PASSWORD="cluster_password"
8.7.3. 扩展 pod 的注意事项
根据 JGroups 中的发现机制,启动节点将搜索现有集群协调器节点。如果在给定超时内找不到协调器节点,则起始节点会假定它是第一个成员,它会占用协调器状态。
当多个节点同时启动时,它们都假定第一个成员为第一个成员,从而导致使用多个分区的分割集群。例如,使用 DeploymentConfig
API 扩展从 0 到 2 个 pod 可能会导致分割集群创建。为避免这种情况,您需要启动第一个 pod,然后再扩展至所需 pod 数量。
默认情况下,EAP Operator 使用 StatefulSet
API,按顺序启动 pod,即逐个启动 pod,从而防止创建拆分集群。
8.8. 健康检查
OpenShift 镜像的 JBoss EAP 默认使用 OpenShift 中包含的 存活度和就绪度探测。此外,此镜像包含 Eclipse MicroProfile Health,如配置指南中所述。
下表显示了这些健康检查通过所需的值。如果状态不是下面找到的值,则检查失败,且镜像重启策略都会重启。
8.9. 消息传递
8.9.1. 配置外部 Red Hat AMQ Broker
您可以使用环境变量为 OpenShift 镜像配置 JBoss EAP,以连接到外部 Red Hat AMQ 代理。
OpenShift 应用定义示例
以下示例使用模板来创建连接到外部 Red Hat AMQ 7 代理的 JBoss EAP 应用程序。
示例: JDK 8
oc new-app eap74-amq-s2i \ -p EAP_IMAGE_NAME=jboss-eap74-openjdk8-openshift:7.4.0 \ -p EAP_RUNTIME_IMAGE_NAME=jboss-eap74-openjdk8-runtime-openshift:7.4.0 \ -p APPLICATION_NAME=eap74-mq \ -p MQ_USERNAME=MY_USERNAME \ -p MQ_PASSWORD=MY_PASSWORD
本例中使用的模板为所需参数提供有效的默认值。如果不使用模板并提供自己的参数,请注意 MQ_SERVICE_PREFIX_MAPPING
名称必须与 APPLICATION_NAME
名称匹配,并附加 "-amq7=MQ"。
8.10. 安全域
若要配置新的安全域,用户必须定义 SECDOMAIN_NAME
环境变量。
这将生成以 环境变量命名的安全域。用户也可以定义以下环境变量来自定义域:
表 8.6. 安全域
变量名称 | 描述 |
---|---|
SECDOMAIN_NAME | 定义一个额外的安全域。
示例值: |
SECDOMAIN_PASSWORD_STACKING |
如果定义,则启用
示例值: |
SECDOMAIN_LOGIN_MODULE | 要使用的登录模块。
默认为 |
SECDOMAIN_USERS_PROPERTIES | 包含用户定义的属性文件的名称。
默认为 |
SECDOMAIN_ROLES_PROPERTIES | 包含角色定义的属性文件的名称。
默认为 |
8.11. HTTPS 环境变量
变量名称 | 描述 |
---|---|
HTTPS_NAME |
如果与
如果您使用
示例值: |
HTTPS_PASSWORD |
如果与
示例值: |
HTTPS_KEYSTORE |
如果与
示例值: |
8.12. 管理环境变量
表 8.7. 管理环境变量
变量名称 | 描述 |
---|---|
ADMIN_USERNAME |
如果定义了这个和
示例值: |
ADMIN_PASSWORD |
指定
示例值: |
8.13. S2I
该镜像包括 S2I 脚本和 Maven。
Maven 目前仅支持将应当部署到 OpenShift 上基于 JBoss EAP 的容器(或相关的/级镜像)的应用程序的构建工具。
目前只支持 WAR 部署。
8.13.1. 自定义配置
可以为镜像添加自定义配置文件。放入 configuration/
目录的所有文件都将复制到 EAP_HOME/standalone/configuration/
中。例如,要覆盖镜像中使用的默认配置,只需将自定义 standalone-openshift.xml
添加到 configuration/
目录中。有关这样的部署,请参阅示例。
8.13.1.1. 自定义模块
可以添加自定义模块。modules/
目录中的所有文件将复制到 EAP_HOME/modules/
中。有关这样的部署,请参阅示例。
8.13.2. Deployment Artifacts
默认情况下,将部署源 target
目录中的工件。要从不同的目录部署,请在 BuildConfig 定义中设置 ARTIFACT_DIR
环境变量。ARTIFACT_DIR
是以逗号分隔的列表。例如: ARTIFACT_DIR=app1/target,app2/target,app3/target
8.13.3. artifact Repository Mirrors
Maven 中的存储库包含各种类型的构建工件和依赖项,如项目 JAR、库 JAR、插件或任何其他项目特定的工件。它还指定在执行 S2I 构建时从哪里下载工件的位置。除了使用中央存储库外,组织也是一种常见做法,部署本地自定义镜像存储库。
使用镜像的好处有:
- 同步镜像的可用性,这种镜像更为严格且更快。
- 能够对存储库内容有更大的控制。
- 可能会在不同的团队(developers、CI)共享工件,而无需依赖公共服务器和存储库。
- 改进构建时间。
通常,存储库管理器可以充当镜像的本地缓存。假设存储库管理器已经在 https://10.0.0.1:8443/repository/internal/
进行了部署并可访问,然后 S2I 构建可以通过向应用程序的构建配置提供 MAVEN_MIRROR_URL
环境变量来使用此管理器:
识别构建配置的名称,以应用
MAVEN_MIRROR_URL
变量。oc get bc -o name buildconfig/eap
使用
MAVEN_MIRROR_URL
环境变量更新eap
的构建配置。oc env bc/eap MAVEN_MIRROR_URL="https://10.0.0.1:8443/repository/internal/" buildconfig "eap" updated
验证设置。
oc env bc/eap --list # buildconfigs eap MAVEN_MIRROR_URL=https://10.0.0.1:8443/repository/internal/
- 调度应用的新构建。
在应用构建期间,您将注意到从存储库管理器中提取 Maven 依赖项,而不是默认的公共存储库。另外,在构建完成后,您会看到镜像已填充并在构建期间使用的所有依赖项。
8.13.3.1. 安全 Artifact Repository Mirror URL
为了防止通过 Maven 存储库进行"man-in-the-middle"攻击,JBoss EAP 需要使用安全 URL 进行工件存储库镜像 URL。
URL 应该指定安全 http("https")和安全端口。
默认情况下,如果指定未安全 URL,将返回错误。您可以使用属性 -Dinsecure.repositories=WARN
覆盖此行为。
8.13.4. 脚本
run
-
此脚本使用
openshift-launch.sh
脚本,该脚本使用standalone-openshift.xml
配置配置和启动 JBoss EAP。 assemble
-
此脚本使用 Maven 构建源,创建软件包(WAR),并将它移到
EAP_HOME/standalone/deployments
目录。
8.13.5. 自定义脚本
您可以在启动 pod 时添加自定义脚本,然后再启动 JBoss EAP。
您可以在启动 pod 时添加有效的脚本,包括 CLI 脚本。
从镜像启动 JBoss EAP 时可使用两个选项,包括脚本:
- 挂载要作为 postconfigure.sh 执行的 configmap
- 在提名安装目录中添加一个 install.sh 脚本
8.13.5.1. 挂载 configmap 以执行自定义脚本
在要在运行时将自定义脚本挂载到现有镜像(换句话说,已构建的镜像)时,挂载 configmap。
挂载 configmap:
使用您要包含在 postconfigure.sh 中的内容创建 configmap。
例如,在项目根目录中创建一个名为
extensions
的目录,使其包含脚本postconfigure.sh
和extensions.cli
,再运行以下命令:$ oc create configmap jboss-cli --from-file=postconfigure.sh=extensions/postconfigure.sh --from-file=extensions.cli=extensions/extensions.cli
通过部署控制器(dc)将 configmap 挂载到 pod。
$ oc set volume dc/eap-app --add --name=jboss-cli -m /opt/eap/extensions -t configmap --configmap-name=jboss-cli --default-mode='0755' --overwrite
postconfigure.sh
示例
#!/usr/bin/env bash set -x echo "Executing postconfigure.sh" $JBOSS_HOME/bin/jboss-cli.sh --file=$JBOSS_HOME/extensions/extensions.cli
extensions.cli
示例
embed-server --std-out=echo --server-config=standalone-openshift.xml :whoami quit
8.13.5.2. 使用 install.sh 执行自定义脚本
当您要在镜像构建时将脚本包含在镜像中时,请使用 install.sh。
使用 install.sh 执行自定义脚本:
-
在 s2i 构建期间使用的项目的 git 存储库中,创建名为
.s2i
的目录。 在
s2i
目录中添加一个名为 environment 的文件,其内容如下:$ cat .s2i/environment CUSTOM_INSTALL_DIRECTORIES=extensions
-
创建名为
extensions
的目录。 在
extensions
目录中,使用类似以下内容的内容创建文件 postconfigure.sh(将占位符代码替换为适用于环境的相应代码):$ cat extensions/postconfigure.sh #!/usr/bin/env bash echo "Executing patch.cli" $JBOSS_HOME/bin/jboss-cli.sh --file=$JBOSS_HOME/extensions/some-cli-example.cli
在 extensions 目录中,使用类似以下内容的内容创建 install.sh 文件(使用适合您的环境的代码替换占位符代码):
$ cat extensions/install.sh #!/usr/bin/env bash set -x echo "Running $PWD/install.sh" injected_dir=$1 # copy any needed files into the target build. cp -rf ${injected_dir} $JBOSS_HOME/extensions
8.13.6. 环境变量
您可以通过向 s2i build
命令提供环境变量来影响构建的执行方式。可以提供的环境变量有:
表 8.8. s2i 环境变量
变量名称 | 描述 |
---|---|
ARTIFACT_DIR |
来自该目录的
示例值: |
ENABLE_GENERATE_DEFAULT_DATASOURCE |
可选。当包含值 |
GALLEON_PROVISION_DEFAULT_FAT_SERVER |
可选。在值 |
GALLEON_PROVISION_LAYERS | 可选。指示 S2I 进程置备指定的层。值是要调配的以逗号分隔的层列表,包括一个基础层和任意数量的 decorator 层。
示例值: |
HTTP_PROXY_HOST | 用于 Maven 的 HTTP 代理的主机名或 IP 地址。
示例值: |
HTTP_PROXY_PORT | 用于 Maven 的 HTTP 代理的 TCP 端口。
示例值: |
HTTP_PROXY_USERNAME |
如果提供给
示例值: |
HTTP_PROXY_PASSWORD |
如果由
示例值: |
HTTP_PROXY_NONPROXYHOSTS | 如果提供,配置的 HTTP 代理将忽略这些主机。
示例值: |
MAVEN_ARGS | 覆盖在构建期间提供给 Maven 的参数。
示例值: |
MAVEN_ARGS_APPEND | 在构建期间附加提供给 Maven 的用户参数。
示例值: |
MAVEN_MIRROR_URL | 用于配置 Maven Mirror/repository Manager 的 URL。
示例值: 请注意,指定的 URL 应安全。详情请查看 第 8.13.3.1 节 “安全 Artifact Repository Mirror URL”。 |
MAVEN_CLEAR_REPO | (可选)在构建后清除本地 Maven 存储库。 如果镜像中存在的服务器与本地缓存强结合,则不会删除缓存,并打印警告。
示例值: |
APP_DATADIR | 如果定义,则源中的目录从其中复制数据文件。
示例值 |
DATA_DIR |
复制
示例值: |
如需更多信息,请参阅 OpenShift 镜像在 JBoss EAP 上构建并运行 Java 应用,它使用 Maven 和包含在 OpenShift 镜像的 JBoss EAP 中的 S2I 脚本。
8.14. 单点登录镜像
此镜像包括红帽单点登录应用程序。
有关使用 OpenShift 镜像为 OpenShift 镜像部署 Red Hat Single Sign-On 的更多信息,请参阅在 Red Hat Single Sign-On for OpenShift 指南上部署 Red Hat Single Sign-On-enabled 的 JBoss EAP 镜像。
表 8.9. 单点登录环境变量
变量名称 | 描述 |
---|---|
| 单点登录服务器的 URL。 |
| 已部署应用程序的单点登录域。 |
| Single Sign-On 域的公钥。此字段是可选的,但如果忽略则可能会使应用程序容易受到中间人攻击的影响。 |
| 访问单点登录 REST API 所需的单点登录用户。
示例值: |
|
示例值: |
|
SAML 的密钥存储位置。默认为 |
|
SAML 的密钥存储密码。默认为 |
|
用于 SAML 的密钥和证书的别名。默认为 |
| 单点登录客户端访问类型。(可选)
示例值: |
|
Single Sign-On 的路径将重新重定向到应用程序。默认来匹配 |
|
如果为 |
| 用于机密访问的单点登录客户端机密。
示例值: |
|
如果为
示例值: |
表 8.10. Secrets
变量名称 | 描述 |
---|---|
|
用于访问 SAML 密钥存储的机密。默认值为 |
| 包含密钥存储文件的 secret 名称。
示例值: |
|
包含 truststore 文件的 secret 名称。用于
示例值: |
8.15. 不支持的事务恢复方案
- OpenShift 不支持 JTS 事务。
- OpenShift 不支持 XTS 事务。
- OpenShift 不支持一些第三方用于事务完成和崩溃恢复流程的 XATerminator 接口。
- OpenShift 3 不支持通过 JBoss Remoting 进行事务进行事务处理。
OpenShift 4 和 EAP 操作员支持通过 JBoss Remoting 传播的事务。
8.16. 包括的 JBoss 模块
下表列出了 JBoss EAP 中用于 OpenShift 镜像的 JBoss 模块。
表 8.11. 包括的 JBoss 模块
JBoss Module |
---|
org.jboss.as.clustering.common |
org.jboss.as.clustering.jgroups |
org.jboss.as.ee |
org.jgroups |
org.openshift.ping |
net.oauth.core |
8.17. EAP Operator:API 信息
EAP Operator 引进了以下 API:
8.17.1. WildFlyServer
WildFlyServer
定义自定义 JBoss EAP 资源。
8.17.2. WildFlyServerList
WildFlyServerList
定义 JBoss EAP 部署的列表。
表 8.13. 表
字段 | 描述 | Scheme | 必填 |
---|---|---|---|
| 标准列表的元数据 | false | |
|
| true |
8.17.3. WildFlyServerSpec
WildFlyServerSpec
是 JBoss EAP 资源所需行为的规格。
它使用一个带有 pod 规格的 StatefulSet
,它挂载由 /opt/jboss/wildfly/standalone/data 的存储指定的卷。
表 8.14. WildFlyServerSpec
字段 | 描述 | Scheme | 必填 |
---|---|---|---|
| 要部署的应用程序镜像的名称 | 字符串 | false |
| 应用程序所需的副本数 | int32] | true |
|
spec 以指定如何从 | false | |
|
| false | |
|
|
| false |
|
存储 spec 以指定如何使用存储。如果省略,则使用 | false | |
| 用于运行 JBoss EAP pod 的 ServiceAccount 名称 | 字符串 | false |
|
来自 | false | |
| 容器中存在的环境变量列表 | false | |
|
要作为容器中的卷挂载的机密名称列表。每个 secret 都作为只读卷挂载到 | 字符串 | false |
|
要作为容器中的卷挂载的 | 字符串 | false |
| 禁用对应用程序服务的 HTTP 端口(如果省略)创建路由。 | 布尔值 | false |
| 如果同一客户端 IP 的连接每次都传递到相同的 JBoss EAP 实例/pod(如果忽略,则为错误) | 布尔值 | false |
8.17.4. Resources
Resources
定义 WildflyServer
资源的资源。如果 Resources
字段没有定义,或 Request
或 Limits
为空,则此资源会从 StatefulSet
中删除。这个资源的描述是一个标准容器
资源,它使用 corev1.ResourceRequirements 方案。
8.17.5. StorageSpec
StorageSpec
为 WildFlyServer
资源定义存储。如果未定义 EmptyDir
或 volumeClaimTemplate
,则会使用默认的 EmptyDir
。
EAP Operator 使用来自此 StorageSpec
的信息配置 StatefulSet
,以挂载专用于 JBoss EAP 使用的独立/数据目录的卷来保留自己的数据。例如,事务日志)。如果使用了 EmptyDir
,则该数据不会在 pod 重启后保留。如果部署在 JBoss EAP 上的应用依赖于事务,请指定 volumeClaimTemplate
,以便在 pod 重启时重复使用相同的持久性卷。
表 8.15. 表
字段 | 描述 | Scheme | 必填 |
---|---|---|---|
|
JBoss EAP | false | |
|
PersistentVolumeClaim spec, | false |
8.17.6. StandaloneConfigMapSpec
StandaloneConfigMapSpec
定义 JBoss EAP 单机配置如何从 ConfigMap
读取。如果省略,JBoss EAP 将使用其镜像的 standalone.xml
配置。
表 8.16. StandaloneConfigMapSpec
字段 | 描述 | Scheme | 必填 |
---|---|---|---|
|
包含独立配置 XML 文件的 | 字符串 | true |
key |
值是独立配置 XML 文件的 | 字符串 | false |
8.17.7. WildFlyServerStatus
WildFlyServerStatus
是 JBoss EAP 部署的最新观察状态。只读.
表 8.17. WildFlyServerStatus
字段 | 描述 | Scheme | 必填 |
---|---|---|---|
| 应用程序的实际副本数 | int32 | true |
| HorizontalPodAutoscaler 使用的 pod 选择器 | 字符串 | true |
| 路由到应用程序 HTTP 服务的主机 | 字符串 | true |
| pod 的状态 | true | |
| 缩减清理进程的 pod 数量 | int32 | true |
8.17.8. PodStatus
PodStatus
是运行 JBoss EAP 应用的 Pod 最新观察状态。
表 8.18. PodStatus
字段 | 描述 | Scheme | 必填 |
---|---|---|---|
| pod 的名称 | 字符串 | true |
| 分配给 pod 的 IP 地址 | 字符串 | true |
| 缩减过程中 pod 的状态。状态默认为 ACTIVE,这意味着它服务于请求。 | 字符串 | false |
更新于 2024-02-08