7.2. CRD 参数详情

replicas

要运行的 JBoss Web 服务器镜像的 pod 数量

例如：
副本：2

applicationName

您希望 JWS Operator 部署的 Web 应用程序的名称

应用名称在 OpenShift 命名空间或项目中必须是唯一值。JWS Operator 使用您指定的应用程序名称来创建路由来访问 Web 应用程序。

例如：
applicationName: my-app

useSessionClustering

启用 DNSping 会话集群

默认设置为 false。如果将此参数设置为 true，则镜像必须基于 JBoss Web 服务器镜像，因为会话集群使用 ENV_FILES 环境变量和 shell 脚本在 server.xml 文件中添加集群。

例如：
使用SessionClustering: true

WebImage

一组参数来控制 JWS Operator 如何从现有镜像部署 pod

此参数包含 applicationImage、imagePullSecret、webApp 和 webServerHealthCheck 字段。

webImage:
      applicationImage

要部署的应用程序镜像名称的完整路径

例如：
applicationImage: quay.io/$user/my-image-name

webImage:
      imagePullSecret

JWS Operator 用来从存储库拉取镜像的 secret 名称

secret 必须包含密钥 .dockerconfigjson。JWS Operator 挂载 secret，并使用类似于 --authfile /mount_point/.dockerconfigjson 来从存储库中拉取镜像。

Secret 对象定义文件可以包含多个用户名和密码值或令牌，以允许访问镜像流、构建器镜像和由 JWS Operator 构建的镜像。

例如：
imagePullSecret: mysecret

WebImage:
webApp

描述 JWS Operator 如何构建您要添加到应用程序镜像的 Web 应用程序的一组参数

如果没有指定 webApp 参数，JWS Operator 会在不构建应用程序的情况下部署 Web 应用程序。

此参数包含 名称,sourceRepositoryURL,sourceRepositoryRef,contextDir,webAppWarImage,webAppWarImagePushSecret, 和 builder 字段。

webImage:
      webApp:
           name

Web 应用程序文件的名称

默认名称为 ROOT.war。

例如：
name: my-app.war

webImage:
      webApp:
           sourceRepositoryURL

应用程序源文件所在的 URL

源应包含 Maven pom.xml 文件来支持 Maven 构建。当 Maven 为应用程序生成 .war 文件时，.war 文件将复制到 JWS Operator 用来部署应用的镜像的 webapps 目录中（例如 /opt/jws-5.x/tomcat/webapps）。

例如：
sourceRepositoryUrl: 'https://github.com/$user/demo-webapp.git'

webImage:
      webApp:
           sourceRepositoryRef

JWS Operator 使用的源存储库的分支

例如：
sourceRepositoryRef: main

webImage:
      webApp:
           contextDir

pom.xml 文件所在的源存储库中的子目录，并且运行 mvn install 命令

例如：
contextDir: /

webImage:
      webApp:
           webAppWarImage

JWS Operator 推送构建的镜像的 URL

webImage:
      webApp:
           webAppWarImagePushSecret

JWS Operator 用来将镜像推送到存储库的 secret 名称

secret 必须包含密钥 .dockerconfigjson。JWS Operator 挂载 secret，并使用类似于 --authfile /mount_point/.dockerconfigjson 来将镜像推送到存储库。

如果 JWS Operator 使用 pull secret 从存储库中拉取镜像，您必须将 pull secret 的名称指定为 webAppWarImagePushSecret 参数的值。如需更多信息，请参阅 imagePullSecret。

例如：
imagePullSecret: mysecret

WebImage:
webApp:
builder

组参数，用于描述 JWS Operator 如何构建 Web 应用程序，并创建镜像并将其推送到镜像存储库

此参数包含 镜像、imagePullSecret 和 applicationBuildScript 字段。

WebImage:
webApp:
builder:
image

JWS Operator 构建 Web 应用的容器的镜像

例如：
镜像：quay.io/$user/tomcat10-buildah

WebImage:
webApp:
builder:
imagePullSecret

JWS Operator 用来从存储库拉取构建器镜像的 secret （如果指定）名称

secret 必须包含密钥 .dockerconfigjson。JWS Operator 挂载 secret，并使用类似于 --authfile /mount_point/.dockerconfigjson 来从存储库中拉取镜像。

Secret 对象定义文件可以包含多个用户名和密码值或令牌，以允许访问镜像流、构建器镜像和由 JWS Operator 构建的镜像。

例如：
imagePullSecret: mysecret

WebImage:
webApp:
builder:
applicationBuildScript

构建器镜像用来构建应用程序 .war 文件的脚本，并将其移到 /mnt 目录中

如果没有为此参数指定值，则构建器镜像将使用 Maven 和 Buildah 的默认脚本。

webImage:
      webServerHealthCheck

JWS Operator 是否使用健康检查

默认行为是使用 health valve，这不需要任何参数。

此参数包含 serverReadinessScript 和 serverLivenessScript 字段。

webImage:
      webServerHealthCheck:
           serverReadinessScript

指定 pod 就绪度健康检查逻辑的字符串

如果没有指定此参数，JWS Operator 会使用 OpenShift 内部 registry 默认健康检查来检查 http://localhost:8080/health。

例如：
serverReadinessScript: /bin/bash -c " /usr/bin/curl --noproxy 'motd' -s 'http://localhost:8080/health' | /usr/bin/grep -i 'status114UP'"

webImage:
      webServerHealthCheck:
           serverLivenessScript

指定 Pod 存活度健康检查逻辑的字符串

这个参数是可选的。

webImageStream

一组参数来控制 JWS Operator 如何使用提供镜像运行或构建的镜像流。

JWS Operator 使用镜像流中的最新镜像。

此参数包含 applicationImage、imagePullSecret、webApp 和 webServerHealthCheck 字段。

webImageStream:
      imageStreamName

您为允许 JWS Operator 查找基础镜像而创建的镜像流的名称

例如：
imageStreamName: my-image-name-imagestream:latest

webImageStream:
      imageStreamNamespace

创建镜像流的命名空间或项目

例如：
imageStreamNamespace: my-namespace

webImageStream:
      webSources

描述应用程序源文件所在的一组参数以及如何构建它们

如果没有指定 webSources 参数，JWS Operator 会在镜像流中部署最新的镜像。

此参数包含 sourceRepositoryUrl,sourceRepositoryRef,contextDir, 和 webSourcesParams 字段。

webImageStream:
      webSources:
           sourceRepositoryUrl

应用程序源文件所在的 URL

源应包含 Maven pom.xml 文件来支持 Maven 构建。当 Maven 为应用程序生成 .war 文件时，.war 文件将复制到 JWS Operator 用来部署应用的镜像的 webapps 目录中（例如 /opt/jws-5.x/tomcat/webapps）。

例如：
sourceRepositoryUrl: 'https://github.com/$user/demo-webapp.git'

webImageStream:
      webSources:
           sourceRepositoryRef

JWS Operator 使用的源存储库的分支

例如：
sourceRepositoryRef: main

webImageStream:
      webSources:
           contextDir

pom.xml 文件所在的源存储库中的子目录，并且运行 mvn install 命令

例如：
contextDir: /

webImageStream:
      webSources:
           webSourcesParams

一组描述如何构建应用程序镜像的参数

这个参数是可选的。

此参数包含 mavenMirrorUrl,artifactDir,genericWebHookSecret, 和 githubWebHookSecret 字段。

webImageStream:
webSources:
webSourcesParams:
mavenMirrorUrl

Maven 用来构建 Web 应用的 Maven 代理 URL

如果集群无法访问互联网，则需要此参数。

webImageStream:
webSources:
webSourcesParams:
artifactDir

Maven 存储 Maven 为 Web 应用生成的 .war 文件的目录

此目录的内容复制到 JWS Operator 用来部署应用程序的镜像的 webapps 目录中（例如 /opt/jws-5.x/tomcat/webapps）。

默认值为 target。

webImageStream:
webSources:
webSourcesParams:
genericWebHookSecret

可触发构建的通用 Webhook 的 secret 名称

有关创建 secret 的更多信息，请参阅为通用或 GitHub Webhook 创建 secret。

有关使用通用 Webhook 的更多信息，请参阅 Webhook 触发器。

例如：
genericWebHookSecret: my-secret

webImageStream:
webSources:
webSourcesParams:
githubWebHookSecret

可触发构建的 GitHub Webhook 的 secret 名称

有关创建 secret 的更多信息，请参阅为通用或 GitHub Webhook 创建 secret。

有关使用 GitHub Webhook 的更多信息，请参阅 Webhook 触发器。

webImageStream:
      webServerHealthCheck

JWS Operator 是否使用健康检查

默认行为是使用 health valve，这不需要任何参数。

此参数包含 serverReadinessScript 和 serverLivenessScript 字段。

webImageStream:
      webServerHealthCheck:
           serverReadinessScript

指定 pod 就绪度健康检查逻辑的字符串

如果没有指定此参数，JWS Operator 会使用 OpenShift 内部 registry 默认健康检查来检查 http://localhost:8080/health。

例如：
serverReadinessScript: /bin/bash -c " /usr/bin/curl --noproxy 'motd' -s 'http://localhost:8080/health' | /usr/bin/grep -i 'status114UP'"

webImageStream:
      webServerHealthCheck:
           serverLivenessScript

指定 Pod 存活度健康检查逻辑的字符串

这个参数是可选的。