7.2. CRD 参数详情

replicas

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

例如：
replicas: 2

applicationName

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

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

例如：
applicationName: my-app

useSessionClustering

启用 DNSping 会话集群

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

例如：
useSessionClustering: 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 应用程序的容器的镜像

例如：
image: 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 使用的健康检查

默认行为是使用健康 valve，它不需要任何参数。

此参数包含 serverReadinessScript 和 serverLivenessScript 字段。

webImage:
      webServerHealthCheck:
           serverReadinessScript

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

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

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

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：
网络来源：
webhookSecrets

一组指定通过 webhook 触发构建的秘密名称的参数

此参数包含generic 、 github和gitlab字段。

webImageStream：
网络来源：
webhookSecrets：
通用的

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

有关创建机密的更多信息，请参阅为 webhook 创建机密。

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

例如：
通用：jws-secret

webImageStream：
网络来源：
webhookSecrets：
GitHub

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

有关创建机密的更多信息，请参阅为 webhook 创建机密。

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

例如：
github: jws-secret

webImageStream：
网络来源：
webhookSecrets：
GitLab

可以触发构建的 GitLab webhook 的 secret 名称

有关创建机密的更多信息，请参阅为 webhook 创建机密。

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

例如：
gitlab：jws-secret

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 秘密字符串

有关创建机密的更多信息，请参阅为 webhook 创建机密。

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

例如：
genericWebhookSecret: qwerty

webImageStream：
网络来源：
webSourcesParams：
githubWebhookSecret

GitHub 特有的 webhook secret 字符串

有关创建机密的更多信息，请参阅为 webhook 创建机密。

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

webImageStream:
      webServerHealthCheck

JWS Operator 使用的健康检查

默认行为是使用健康 valve，它不需要任何参数。

此参数包含 serverReadinessScript 和 serverLivenessScript 字段。

webImageStream:
      webServerHealthCheck:
           serverReadinessScript

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

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

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

webImageStream:
      webServerHealthCheck:
           serverLivenessScript

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

这个参数是可选的。

tlsConfig

指定 Web 服务器的 TLS 配置的一组参数

此参数包含routeHostname 、 certificateVerification 、 tlsSecret和tlsPassword字段。

tls配置：
路由主机名

指示操作员是否应创建路由或路由是否使用 TLS

支持的值是NONE和tls ：

例如：
路由主机名：NONE

tls配置：
证书验证

指示操作员是否应使用带有客户端证书的 TLS 连接器

支持的值包括required 、 optional或empty 。

有关更多信息，请参阅有关certificateVerification属性的Apache Tomcat HTTP Connector 文档。

例如：
证书验证：必填

tls配置：
tlsSecret

用于服务器证书（ server.cert ）和服务器密钥（ server.key ）的密钥以及用于客户端证书（ ca.cert ）的可选 CA 证书

例如：
tlsSecret：tlssecret

tls配置：
tls密码

用于保护服务器密钥的密码（ server.key ）

例如：
tls密码：changeit

environmentVariables

部署的环境变量

持久日志

指定持久卷和日志配置的一组参数

该参数包含catalinaLogs 、 enableAccessLogs 、 volumeName 、 storageClass字段。

持久日志：
catalina日志

指示每个 pod 的catalina.out日志文件是否保存在持久卷中，以便在可能的 pod 故障后仍然可用。

支持的值是 true 或 false。

例如：
catalinaLogs：true

持久日志：
启用访问日志

指示每个 pod 的access_log日志文件是否保存在持久卷中，以便在可能的 pod 故障后仍然可用。

支持的值是 true 或 false。

例如：
启用访问日志：true

持久日志：
卷名称

用于存储日志文件的持久卷的名称

例如：
卷名称：pv0000

持久日志：
存储类

用于存储日志文件的持久卷的存储类名称

例如：
存储类：nfs-client

podResources

指定 Web 服务器使用的 CPU 和内存资源的配置

这些值必须归类为限制和请求。

例如：

资源：
限制：
CPU：500米
请求：
CPU：200米

这些值用于自动缩放。有关自动缩放的更多信息，请参阅使用水平 Pod 自动缩放器自动缩放 Pod 。

securityContext

定义运行应用程序所需的安全功能

useInsightsClient

指示是否与 Red Hat 提供的运行时清单操作员建立连接

支持的值是 true 或 false。

例如：
useInsightsClient: true

您可以通过将INSIGHTS_DEBUG环境变量设置为true来为 Insights 客户端启用调试日志记录。