×

OpenShift Container Platform 提供一个用于运行 Jenkins 的容器镜像。此镜像提供一个 Jenkins 服务器实例,可用于设置持续测试、集成和交付的基本流程。

此镜像基于 Red Hat 通用基础镜像 (UBI)。

OpenShift Container Platform 遵循 Jenkins 的 LTS 版本。OpenShift Container Platform 提供一个包含 Jenkins 2.x 的镜像。

OpenShift Container Platform Jenkins 镜像可在 Quay.ioregistry.redhat.io 上获得。

例如

$ podman pull registry.redhat.io/ocp-tools-4/jenkins-rhel8:<image_tag>

要使用这些镜像,您可以直接从这些注册表访问它们,或者将它们推送到您的 OpenShift Container Platform 容器镜像注册表中。此外,您可以创建一个指向镜像的镜像流,该镜像流位于您的容器镜像注册表或外部位置。然后,您的 OpenShift Container Platform 资源可以引用该镜像流。

但为了方便起见,OpenShift Container Platform 在 `openshift` 命名空间中为核心 Jenkins 镜像以及为 OpenShift Container Platform 与 Jenkins 集成提供的示例 Agent 镜像提供了镜像流。

配置和自定义

您可以通过两种方式管理 Jenkins 身份验证

  • OpenShift Container Platform OAuth 身份验证,由 OpenShift Container Platform 登录插件提供。

  • Jenkins 提供的标准身份验证。

OpenShift容器平台OAuth身份验证

OAuth身份验证通过在Jenkins UI的**配置全局安全**面板上配置选项来激活,或者通过将Jenkins**部署配置**中的OPENSHIFT_ENABLE_OAUTH环境变量设置为false以外的任何值来激活。这将激活OpenShift容器平台登录插件,该插件从pod数据中检索配置信息,或通过与OpenShift容器平台API服务器交互来检索信息。

有效凭据由OpenShift容器平台身份提供者控制。

Jenkins支持浏览器和非浏览器访问。

有效用户会在登录时自动添加到Jenkins授权矩阵中,其中OpenShift容器平台角色决定用户拥有的特定Jenkins权限。默认使用的角色是预定义的admineditview。登录插件会对Jenkins运行所在的项目或命名空间中的这些角色执行自我SAR请求。

拥有admin角色的用户拥有传统的Jenkins管理员用户权限。拥有editview角色的用户权限逐渐减少。

默认的OpenShift容器平台admineditview角色以及在Jenkins实例中为这些角色分配的Jenkins权限是可配置的。

当在OpenShift容器平台pod中运行Jenkins时,登录插件会在Jenkins运行的命名空间中查找名为openshift-jenkins-login-plugin-config的配置映射。

如果此插件找到并可以读取该配置映射,则可以定义角色与Jenkins权限的映射。具体来说:

  • 登录插件将配置映射中的键值对视为Jenkins权限到OpenShift容器平台角色的映射。

  • 键是Jenkins权限组短ID和Jenkins权限短ID,两者之间用连字符分隔。

  • 如果要将总体Jenkins管理权限添加到OpenShift容器平台角色,则键应为Overall-Administer

  • 要了解哪些权限组和权限ID可用,请访问Jenkins控制台中的矩阵授权页面,以及他们提供的表格中组和单个权限的ID。

  • 键值对的值是要应用权限的OpenShift容器平台角色列表,每个角色之间用逗号分隔。

  • 如果要将总体Jenkins管理权限同时添加到默认的adminedit角色以及您创建的新Jenkins角色,则键Overall-Administer的值将为admin,edit,jenkins

在OpenShift容器平台Jenkins镜像中预先填充的具有管理权限的admin用户在使用OpenShift容器平台OAuth时不会获得这些权限。要授予这些权限,OpenShift容器平台集群管理员必须在OpenShift容器平台身份提供者中显式定义该用户,并将admin角色分配给该用户。

用户权限可以在用户最初建立后更改。OpenShift容器平台登录插件会轮询OpenShift容器平台API服务器以获取权限,并使用从OpenShift容器平台检索到的权限更新Jenkins中每个用户的存储权限。如果使用Jenkins UI更新Jenkins用户的权限,则下次插件轮询OpenShift容器平台时,权限更改将被覆盖。

您可以使用OPENSHIFT_PERMISSIONS_POLL_INTERVAL环境变量控制轮询的频率。默认轮询间隔为五分钟。

使用OAuth身份验证创建新的Jenkins服务的最佳方法是使用模板。

Jenkins身份验证

如果直接运行镜像(不使用模板),则默认情况下使用Jenkins身份验证。

Jenkins第一次启动时,将创建配置以及管理员用户和密码。默认用户凭据为adminpassword。仅当使用标准Jenkins身份验证时,通过设置JENKINS_PASSWORD环境变量来配置默认密码。

步骤
  • 通过输入以下命令创建使用标准Jenkins身份验证的Jenkins应用程序:

    $ oc new-app -e \
        JENKINS_PASSWORD=<password> \
        ocp-tools-4/jenkins-rhel8

Jenkins环境变量

Jenkins服务器可以使用以下环境变量进行配置:

变量 定义 示例值和设置

OPENSHIFT_ENABLE_OAUTH

确定登录Jenkins时OpenShift容器平台登录插件是否管理身份验证。要启用,请设置为true

默认值:false

JENKINS_PASSWORD

使用标准Jenkins身份验证时admin用户的密码。当OPENSHIFT_ENABLE_OAUTH设置为true时不适用。

默认值:password

JAVA_MAX_HEAP_PARAMCONTAINER_HEAP_PERCENTJENKINS_MAX_HEAP_UPPER_BOUND_MB

这些值控制Jenkins JVM的最大堆大小。如果设置了JAVA_MAX_HEAP_PARAM,则其值优先。否则,最大堆大小将动态计算为容器内存限制的CONTAINER_HEAP_PERCENT,可选地限制为JENKINS_MAX_HEAP_UPPER_BOUND_MB MiB。

默认情况下,Jenkins JVM的最大堆大小设置为容器内存限制的50%,无上限。

JAVA_MAX_HEAP_PARAM示例设置:-Xmx512m

CONTAINER_HEAP_PERCENT默认值:0.5,或50%

JENKINS_MAX_HEAP_UPPER_BOUND_MB示例设置:512 MiB

JAVA_INITIAL_HEAP_PARAMCONTAINER_INITIAL_PERCENT

这些值控制Jenkins JVM的初始堆大小。如果设置了JAVA_INITIAL_HEAP_PARAM,则其值优先。否则,初始堆大小将动态计算为动态计算的最大堆大小的CONTAINER_INITIAL_PERCENT

默认情况下,JVM设置初始堆大小。

JAVA_INITIAL_HEAP_PARAM示例设置:-Xms32m

CONTAINER_INITIAL_PERCENT示例设置:0.1,或10%

CONTAINER_CORE_LIMIT

如果设置,则指定用于确定内部JVM线程数量的内核数。

示例设置:2

JAVA_TOOL_OPTIONS

指定要应用于此容器中运行的所有JVM的选项。不建议覆盖此值。

默认值:-XX:+UnlockExperimentalVMOptions -XX:+UseCGroupMemoryLimitForHeap -Dsun.zip.disableMemoryMapping=true

JAVA_GC_OPTS

指定Jenkins JVM垃圾收集参数。不建议覆盖此值。

默认值:-XX:+UseParallelGC -XX:MinHeapFreeRatio=5 -XX:MaxHeapFreeRatio=10 -XX:GCTimeRatio=4 -XX:AdaptiveSizePolicyWeight=90

JENKINS_JAVA_OVERRIDES

指定Jenkins JVM的其他选项。这些选项将附加到所有其他选项(包括上面的Java选项),如果需要,可用于覆盖任何选项。用空格分隔每个附加选项;如果任何选项包含空格字符,请使用反斜杠对其进行转义。

示例设置:-Dfoo -Dbar-Dfoo=first\ value -Dbar=second\ value

JENKINS_OPTS

指定Jenkins的参数。

INSTALL_PLUGINS

指定在容器第一次运行或OVERRIDE_PV_PLUGINS_WITH_IMAGE_PLUGINS设置为true时要安装的其他Jenkins插件。插件指定为名称:版本的逗号分隔列表。

示例设置:git:3.7.0,subversion:2.10.2

OPENSHIFT_PERMISSIONS_POLL_INTERVAL

指定OpenShift容器平台登录插件轮询OpenShift容器平台以获取与Jenkins中定义的每个用户关联的权限的间隔(以毫秒为单位)。

默认值:300000 - 5分钟

OVERRIDE_PV_CONFIG_WITH_IMAGE_CONFIG

当使用 OpenShift Container Platform 持久卷 (PV) 作为 Jenkins 配置目录运行此镜像时,只有在镜像第一次启动时才会将配置从镜像传输到 PV,因为 PV 是在创建持久卷声明 (PVC) 时分配的。如果您创建扩展此镜像的自定义镜像并在初始启动后更新自定义镜像中的配置,除非您将此环境变量设置为true,否则配置不会被复制。

默认值:false

OVERRIDE_PV_PLUGINS_WITH_IMAGE_PLUGINS

当使用 OpenShift Container Platform PV 作为 Jenkins 配置目录运行此镜像时,只有在镜像第一次启动时才会将插件从镜像传输到 PV,因为 PV 是在创建 PVC 时分配的。如果您创建扩展此镜像的自定义镜像并在初始启动后更新自定义镜像中的插件,除非您将此环境变量设置为true,否则插件不会被复制。

默认值:false

ENABLE_FATAL_ERROR_LOG_FILE

当使用 OpenShift Container Platform PVC 作为 Jenkins 配置目录运行此镜像时,此环境变量允许在发生致命错误时持久化致命错误日志文件。致命错误文件保存在/var/lib/jenkins/logs目录下。

默认值:false

AGENT_BASE_IMAGE

设置此值将覆盖此镜像提供的 Kubernetes 插件示例 Pod 模板中用于jnlp容器的镜像。否则,将使用openshift命名空间中jenkins-agent-base-rhel8:latest镜像流标签中的镜像。

默认值:image-registry.openshift-image-registry.svc:5000/openshift/jenkins-agent-base-rhel8:latest

JAVA_BUILDER_IMAGE

设置此值将覆盖此镜像提供的java-builder Kubernetes 插件示例 Pod 模板中用于java-builder容器的镜像。否则,将使用openshift命名空间中java:latest镜像流标签中的镜像。

默认值:image-registry.openshift-image-registry.svc:5000/openshift/java:latest

JAVA_FIPS_OPTIONS

设置此值控制 JVM 在 FIPS 节点上运行时的操作方式。更多信息,请参见在 FIPS 模式下配置 Red Hat 版本的 OpenJDK 11

默认值:-Dcom.redhat.fips=false

提供 Jenkins 跨项目访问

如果您要在项目之外运行 Jenkins,则必须向 Jenkins 提供访问令牌才能访问您的项目。

步骤
  1. 通过输入以下命令来标识具有访问 Jenkins 必须访问的项目所需权限的服务帐户的密钥

    $ oc describe serviceaccount jenkins
    示例输出
    Name:       default
    Labels:     <none>
    Secrets:    {  jenkins-token-uyswp    }
                {  jenkins-dockercfg-xcr3d    }
    Tokens:     jenkins-token-izv1u
                jenkins-token-uyswp

    在本例中,密钥名为jenkins-token-uyswp

  2. 通过输入以下命令从密钥中检索令牌

    $ oc describe secret <secret name from above>
    示例输出
    Name:       jenkins-token-uyswp
    Labels:     <none>
    Annotations:    kubernetes.io/service-account.name=jenkins,kubernetes.io/service-account.uid=32f5b661-2a8f-11e5-9528-3c970e3bf0b7
    Type:   kubernetes.io/service-account-token
    Data
    ====
    ca.crt: 1066 bytes
    token:  eyJhbGc..<content cut>....wRA

    token 参数包含 Jenkins 访问项目所需的令牌值。

Jenkins 跨卷挂载点

Jenkins 镜像可以与挂载的卷一起运行,以启用配置的持久存储。

  • /var/lib/jenkins 是 Jenkins 用于存储配置文件(包括作业定义)的数据目录。

通过 source-to-image 自定义 Jenkins 镜像

要自定义官方 OpenShift Container Platform Jenkins 镜像,可以使用该镜像作为 source-to-image (S2I) 构建器。

您可以使用 S2I 复制自定义 Jenkins 作业定义,添加其他插件,或将提供的config.xml文件替换为您自己的自定义配置。

要将您的修改包含在 Jenkins 镜像中,您必须拥有具有以下目录结构的 Git 存储库

plugins

此目录包含您想要复制到 Jenkins 的二进制 Jenkins 插件。

plugins.txt

此文件列出了您要使用以下语法安装的插件

pluginId:pluginVersion
configuration/jobs

此目录包含 Jenkins 作业定义。

configuration/config.xml

此文件包含您的自定义 Jenkins 配置。

configuration/目录的内容将复制到/var/lib/jenkins/目录,因此您也可以在那里包含其他文件,例如credentials.xml

在 OpenShift Container Platform 中自定义 Jenkins 镜像的示例构建配置
apiVersion: build.openshift.io/v1
kind: BuildConfig
metadata:
  name: custom-jenkins-build
spec:
  source:                       (1)
    git:
      uri: https://github.com/custom/repository
    type: Git
  strategy:                     (2)
    sourceStrategy:
      from:
        kind: ImageStreamTag
        name: jenkins:2
        namespace: openshift
    type: Source
  output:                       (3)
    to:
      kind: ImageStreamTag
      name: custom-jenkins:latest
1 source参数定义具有上述布局的源 Git 存储库。
2 strategy参数定义用作构建源镜像的原始 Jenkins 镜像。
3 output参数定义生成的自定义 Jenkins 镜像,您可以在部署配置中使用它来代替官方 Jenkins 镜像。

配置 Jenkins Kubernetes 插件

OpenShift Jenkins 镜像预安装了Jenkins Kubernetes 插件,以便可以使用 Kubernetes 和 OpenShift Container Platform 在多个容器主机上动态配置 Jenkins 代理。

要使用 Kubernetes 插件,OpenShift Container Platform 提供了一个适合用作 Jenkins 代理的 OpenShift Agent Base 镜像。

OpenShift Container Platform 4.11 将 OpenShift Jenkins 和 OpenShift Agent Base 镜像移至registry.redhat.io上的ocp-tools-4存储库,以便 Red Hat 可以在 OpenShift Container Platform 生命周期之外生成和更新这些镜像。以前,这些镜像位于 OpenShift Container Platform 安装负载和registry.redhat.io上的openshift4存储库中。

OpenShift Jenkins Maven 和 NodeJS Agent 镜像已从 OpenShift Container Platform 4.11 负载中移除。Red Hat 不再生成这些镜像,并且它们也无法从registry.redhat.io上的ocp-tools-4存储库中获得。Red Hat 维护这些镜像的 4.10 和更早版本,以解决任何重大错误修复或安全 CVE,遵循OpenShift Container Platform 生命周期策略

更多信息,请参见以下“其他资源”部分中的“OpenShift Jenkins 镜像的重要更改”链接。

Maven 和 Node.js 代理镜像在 OpenShift Container Platform Jenkins 镜像配置中被自动配置为 Kubernetes pod 模板镜像,用于 Kubernetes 插件。该配置包括您可以应用于其“限制此项目可在何处运行”设置下的任何 Jenkins 作业的每个镜像的标签。如果应用了标签,则作业将在运行相应代理镜像的 OpenShift Container Platform pod 下运行。

在 OpenShift Container Platform 4.10 及更高版本中,使用 Kubernetes 插件运行 Jenkins 代理的推荐模式是使用同时具有jnlpsidecar容器的 pod 模板。jnlp容器使用 OpenShift Container Platform Jenkins Base 代理镜像来促进为您的构建启动一个单独的 pod。sidecar容器镜像具有在启动的单独 pod 中以特定语言进行构建所需的工具。Red Hat Container Catalog 中的许多容器镜像都引用了openshift命名空间中的示例镜像流。OpenShift Container Platform Jenkins 镜像有一个名为java-build的 pod 模板,其中包含演示此方法的 sidecar 容器。此 pod 模板使用openshift命名空间中java镜像流提供的最新 Java 版本。

Jenkins 镜像还提供 Kubernetes 插件附加代理镜像的自动发现和自动配置。

使用 OpenShift Container Platform 同步插件,在 Jenkins 启动时,Jenkins 镜像会在其运行的项目或插件配置中列出的项目中搜索以下项目

  • 具有设置为jenkins-agentrole标签的镜像流。

  • 具有设置为jenkins-agentrole注释的镜像流标签。

  • 具有设置为jenkins-agentrole标签的配置映射。

当 Jenkins 镜像找到带有相应标签的镜像流或带有相应注解的镜像流标签时,它会生成相应的 Kubernetes 插件配置。这样,您可以将 Jenkins 作业分配到运行由镜像流提供的容器镜像的 Pod 中。

镜像流或镜像流标签的名称和镜像引用映射到 Kubernetes 插件 Pod 模板中的名称和镜像字段。您可以通过在镜像流或镜像流标签对象上设置键为agent-label的注解来控制 Kubernetes 插件 Pod 模板的标签字段。否则,名称将用作标签。

不要登录到 Jenkins 控制台并更改 Pod 模板配置。如果您在创建 Pod 模板后这样做,并且 OpenShift Container Platform 同步插件检测到与镜像流或镜像流标签关联的镜像已更改,它将替换 Pod 模板并覆盖这些配置更改。您无法将新的配置与现有配置合并。

如果您有更复杂的配置需求,请考虑使用 ConfigMap 方法。

当它找到具有相应标签的 ConfigMap 时,Jenkins 镜像会假定 ConfigMap 的键值数据有效负载中的任何值都包含与 Jenkins 和 Kubernetes 插件 Pod 模板的配置格式一致的可扩展标记语言 (XML)。与镜像流和镜像流标签相比,ConfigMap 的一个主要优点是您可以控制所有 Kubernetes 插件 Pod 模板参数。

jenkins-agent 的示例 ConfigMap
kind: ConfigMap
apiVersion: v1
metadata:
  name: jenkins-agent
  labels:
    role: jenkins-agent
data:
  template1: |-
    <org.csanchez.jenkins.plugins.kubernetes.PodTemplate>
      <inheritFrom></inheritFrom>
      <name>template1</name>
      <instanceCap>2147483647</instanceCap>
      <idleMinutes>0</idleMinutes>
      <label>template1</label>
      <serviceAccount>jenkins</serviceAccount>
      <nodeSelector></nodeSelector>
      <volumes/>
      <containers>
        <org.csanchez.jenkins.plugins.kubernetes.ContainerTemplate>
          <name>jnlp</name>
          <image>openshift/jenkins-agent-maven-35-centos7:v3.10</image>
          <privileged>false</privileged>
          <alwaysPullImage>true</alwaysPullImage>
          <workingDir>/tmp</workingDir>
          <command></command>
          <args>${computer.jnlpmac} ${computer.name}</args>
          <ttyEnabled>false</ttyEnabled>
          <resourceRequestCpu></resourceRequestCpu>
          <resourceRequestMemory></resourceRequestMemory>
          <resourceLimitCpu></resourceLimitCpu>
          <resourceLimitMemory></resourceLimitMemory>
          <envVars/>
        </org.csanchez.jenkins.plugins.kubernetes.ContainerTemplate>
      </containers>
      <envVars/>
      <annotations/>
      <imagePullSecrets/>
      <nodeProperties/>
    </org.csanchez.jenkins.plugins.kubernetes.PodTemplate>

以下示例显示了两个容器,它们引用了 openshift 命名空间中的镜像流。一个容器处理用于将 Pod 作为 Jenkins Agent 启动的 JNLP 协定。另一个容器使用具有工具的镜像,用于以特定的编码语言构建代码。

kind: ConfigMap
apiVersion: v1
metadata:
  name: jenkins-agent
  labels:
    role: jenkins-agent
data:
  template2: |-
        <org.csanchez.jenkins.plugins.kubernetes.PodTemplate>
          <inheritFrom></inheritFrom>
          <name>template2</name>
          <instanceCap>2147483647</instanceCap>
          <idleMinutes>0</idleMinutes>
          <label>template2</label>
          <serviceAccount>jenkins</serviceAccount>
          <nodeSelector></nodeSelector>
          <volumes/>
          <containers>
            <org.csanchez.jenkins.plugins.kubernetes.ContainerTemplate>
              <name>jnlp</name>
              <image>image-registry.openshift-image-registry.svc:5000/openshift/jenkins-agent-base-rhel8:latest</image>
              <privileged>false</privileged>
              <alwaysPullImage>true</alwaysPullImage>
              <workingDir>/home/jenkins/agent</workingDir>
              <command></command>
              <args>\$(JENKINS_SECRET) \$(JENKINS_NAME)</args>
              <ttyEnabled>false</ttyEnabled>
              <resourceRequestCpu></resourceRequestCpu>
              <resourceRequestMemory></resourceRequestMemory>
              <resourceLimitCpu></resourceLimitCpu>
              <resourceLimitMemory></resourceLimitMemory>
              <envVars/>
            </org.csanchez.jenkins.plugins.kubernetes.ContainerTemplate>
            <org.csanchez.jenkins.plugins.kubernetes.ContainerTemplate>
              <name>java</name>
              <image>image-registry.openshift-image-registry.svc:5000/openshift/java:latest</image>
              <privileged>false</privileged>
              <alwaysPullImage>true</alwaysPullImage>
              <workingDir>/home/jenkins/agent</workingDir>
              <command>cat</command>
              <args></args>
              <ttyEnabled>true</ttyEnabled>
              <resourceRequestCpu></resourceRequestCpu>
              <resourceRequestMemory></resourceRequestMemory>
              <resourceLimitCpu></resourceLimitCpu>
              <resourceLimitMemory></resourceLimitMemory>
              <envVars/>
            </org.csanchez.jenkins.plugins.kubernetes.ContainerTemplate>
          </containers>
          <envVars/>
          <annotations/>
          <imagePullSecrets/>
          <nodeProperties/>
        </org.csanchez.jenkins.plugins.kubernetes.PodTemplate>

不要登录到 Jenkins 控制台并更改 Pod 模板配置。如果您在创建 Pod 模板后这样做,并且 OpenShift Container Platform 同步插件检测到与镜像流或镜像流标签关联的镜像已更改,它将替换 Pod 模板并覆盖这些配置更改。您无法将新的配置与现有配置合并。

如果您有更复杂的配置需求,请考虑使用 ConfigMap 方法。

安装后,OpenShift Container Platform 同步插件会监控 OpenShift Container Platform 的 API 服务器以获取镜像流、镜像流标签和 ConfigMap 的更新,并调整 Kubernetes 插件的配置。

适用以下规则:

  • 从 ConfigMap、镜像流或镜像流标签中删除标签或注解会删除 Kubernetes 插件配置中任何现有的PodTemplate

  • 如果这些对象被删除,相应的配置将从 Kubernetes 插件中删除。

  • 如果您创建了标记或带注解的ConfigMapImageStreamImageStreamTag 对象,或者在它们初始创建后添加了标签,这将导致在 Kubernetes 插件配置中创建PodTemplate

  • 对于 ConfigMap 形式的PodTemplate,对PodTemplate 的 ConfigMap 数据的更改将应用于 Kubernetes 插件配置中的PodTemplate 设置。这些更改还会覆盖在 ConfigMap 更改之间通过 Jenkins UI 对PodTemplate 进行的任何更改。

要将容器镜像用作 Jenkins agent,该镜像必须运行 agent 作为入口点。有关更多详细信息,请参阅官方 Jenkins 文档

Jenkins 权限

如果在 ConfigMap 中,Pod 模板 XML 的<serviceAccount> 元素是用于生成的 Pod 的 OpenShift Container Platform 服务帐户,则服务帐户凭据将挂载到 Pod 中。权限与服务帐户相关联,并控制允许从 Pod 对 OpenShift Container Platform 主服务器执行哪些操作。

考虑以下场景:使用用于 Pod 的服务帐户,该 Pod 由在 OpenShift Container Platform Jenkins 镜像中运行的 Kubernetes 插件启动。

如果您使用 OpenShift Container Platform 提供的 Jenkins 示例模板,则jenkins 服务帐户使用其项目中 Jenkins 运行的edit 角色进行定义,并且主 Jenkins Pod 挂载了该服务帐户。

注入 Jenkins 配置中的两个默认 Maven 和 NodeJS Pod 模板也设置为使用与 Jenkins 主服务器相同的服务帐户。

  • 由于其镜像流或镜像流标签具有必需的标签或注解,因此由 OpenShift Container Platform 同步插件自动发现的任何 Pod 模板都配置为使用 Jenkins 主服务器服务帐户作为其服务帐户。

  • 对于您可以将 Pod 模板定义提供到 Jenkins 和 Kubernetes 插件的其他方法,您必须显式指定要使用的服务帐户。这些其他方法包括 Jenkins 控制台、Kubernetes 插件提供的podTemplate 管道 DSL,或标记其数据是 Pod 模板的 XML 配置的 ConfigMap。

  • 如果您未指定服务帐户的值,则使用default 服务帐户。

  • 确保使用的任何服务帐户都具有在 OpenShift Container Platform 中定义的必要权限、角色等,以便操作您选择在 Pod 内操作的任何项目。

从模板创建 Jenkins 服务

模板提供参数字段来定义所有环境变量,并具有预定义的默认值。OpenShift Container Platform 提供模板,使创建新的 Jenkins 服务变得容易。Jenkins 模板应在您的集群管理员在初始集群设置期间在默认的openshift 项目中注册。

两个可用的模板都定义了部署配置和服务。模板在存储策略方面有所不同,这会影响 Jenkins 内容在 Pod 重启后是否持久存在。

当 Pod 移动到另一个节点或部署配置的更新触发重新部署时,可能会重新启动 Pod。

  • jenkins-ephemeral 使用短暂存储。Pod 重启后,所有数据都会丢失。此模板仅适用于开发或测试。

  • jenkins-persistent 使用持久卷 (PV) 存储。数据会在 Pod 重启后保留。

要使用 PV 存储,集群管理员必须在 OpenShift Container Platform 部署中定义 PV 池。

选择所需的模板后,必须实例化该模板才能使用 Jenkins。

步骤
  • 使用以下方法之一创建新的 Jenkins 应用程序:

    • PV

      $ oc new-app jenkins-persistent
    • 或者emptyDir 类型卷,其中配置不会在 Pod 重启后持久存在。

      $ oc new-app jenkins-ephemeral

对于这两种模板,您都可以对其运行oc describe 以查看可用于覆盖的所有参数。

例如

$ oc describe jenkins-ephemeral

使用 Jenkins Kubernetes 插件

在以下示例中,openshift-jee-sample BuildConfig 对象会导致动态预配 Jenkins Maven agent Pod。该 Pod 克隆一些 Java 源代码,构建 WAR 文件,并导致第二个BuildConfigopenshift-jee-sample-docker)运行。第二个BuildConfig 将新的 WAR 文件分层到容器镜像中。

OpenShift Container Platform 4.11 已将其有效负载中的 OpenShift Jenkins Maven 和 NodeJS Agent 镜像移除。Red Hat 不再生成这些镜像,并且它们在registry.redhat.ioocp-tools-4 存储库中不可用。Red Hat 维护这些镜像的 4.10 及更早版本,以进行任何重要的错误修复或安全 CVE,遵循 OpenShift Container Platform 生命周期策略

更多信息,请参见以下“其他资源”部分中的“OpenShift Jenkins 镜像的重要更改”链接。

使用 Jenkins Kubernetes 插件的示例BuildConfig
kind: List
apiVersion: v1
items:
- kind: ImageStream
  apiVersion: image.openshift.io/v1
  metadata:
    name: openshift-jee-sample
- kind: BuildConfig
  apiVersion: build.openshift.io/v1
  metadata:
    name: openshift-jee-sample-docker
  spec:
    strategy:
      type: Docker
    source:
      type: Docker
      dockerfile: |-
        FROM openshift/wildfly-101-centos7:latest
        COPY ROOT.war /wildfly/standalone/deployments/ROOT.war
        CMD $STI_SCRIPTS_PATH/run
      binary:
        asFile: ROOT.war
    output:
      to:
        kind: ImageStreamTag
        name: openshift-jee-sample:latest
- kind: BuildConfig
  apiVersion: build.openshift.io/v1
  metadata:
    name: openshift-jee-sample
  spec:
    strategy:
      type: JenkinsPipeline
      jenkinsPipelineStrategy:
        jenkinsfile: |-
          node("maven") {
            sh "git clone https://github.com/openshift/openshift-jee-sample.git ."
            sh "mvn -B -Popenshift package"
            sh "oc start-build -F openshift-jee-sample-docker --from-file=target/ROOT.war"
          }
    triggers:
    - type: ConfigChange

也可以覆盖动态创建的 Jenkins agent pod 的规范。以下是前面示例的修改,它覆盖了容器内存并指定了一个环境变量。

使用 Jenkins Kubernetes 插件的示例BuildConfig,指定内存限制和环境变量
kind: BuildConfig
apiVersion: build.openshift.io/v1
metadata:
  name: openshift-jee-sample
spec:
  strategy:
    type: JenkinsPipeline
    jenkinsPipelineStrategy:
      jenkinsfile: |-
        podTemplate(label: "mypod", (1)
                    cloud: "openshift", (2)
                    inheritFrom: "maven", (3)
                    containers: [
            containerTemplate(name: "jnlp", (4)
                              image: "openshift/jenkins-agent-maven-35-centos7:v3.10", (5)
                              resourceRequestMemory: "512Mi", (6)
                              resourceLimitMemory: "512Mi", (7)
                              envVars: [
              envVar(key: "CONTAINER_HEAP_PERCENT", value: "0.25") (8)
            ])
          ]) {
          node("mypod") { (9)
            sh "git clone https://github.com/openshift/openshift-jee-sample.git ."
            sh "mvn -B -Popenshift package"
            sh "oc start-build -F openshift-jee-sample-docker --from-file=target/ROOT.war"
          }
        }
  triggers:
  - type: ConfigChange
1 动态定义了一个名为mypod的新 pod 模板。节点段中引用了新的 pod 模板名称。
2 cloud值必须设置为openshift
3 新的 pod 模板可以继承其配置自现有的 pod 模板。在本例中,它继承自 OpenShift Container Platform 预定义的 Maven pod 模板。
4 此示例覆盖了预先存在的容器中的值,并且必须按名称指定。OpenShift Container Platform 附带的所有 Jenkins agent 镜像都使用容器名称jnlp
5 再次指定容器镜像名称。这是一个已知问题。
6 指定了512 Mi的内存请求。
7 指定了512 Mi的内存限制。
8 指定了一个环境变量CONTAINER_HEAP_PERCENT,其值为0.25
9 节点段引用了已定义的 pod 模板的名称。

默认情况下,构建完成后 pod 将被删除。此行为可以使用插件或在 pipeline Jenkinsfile 中修改。

最新的上游 Jenkins 引入了 YAML 声明性格式,用于在您的 pipeline 中内联定义podTemplate pipeline DSL。这是一个示例,使用了在 OpenShift Container Platform Jenkins 镜像中定义的示例java-builder pod 模板

def nodeLabel = 'java-buidler'

pipeline {
  agent {
    kubernetes {
      cloud 'openshift'
      label nodeLabel
      yaml """
apiVersion: v1
kind: Pod
metadata:
  labels:
    worker: ${nodeLabel}
spec:
  containers:
  - name: jnlp
    image: image-registry.openshift-image-registry.svc:5000/openshift/jenkins-agent-base-rhel8:latest
    args: ['\$(JENKINS_SECRET)', '\$(JENKINS_NAME)']
  - name: java
    image: image-registry.openshift-image-registry.svc:5000/openshift/java:latest
    command:
    - cat
    tty: true
"""
    }
  }

  options {
    timeout(time: 20, unit: 'MINUTES')
  }

  stages {
    stage('Build App') {
      steps {
        container("java") {
          sh "mvn --version"
        }
     }
    }
  }
}

Jenkins 内存需求

通过提供的 Jenkins Ephemeral 或 Jenkins Persistent 模板部署时,默认内存限制为1 Gi

默认情况下,在 Jenkins 容器中运行的所有其他进程总共不能使用超过512 MiB的内存。如果它们需要更多内存,容器将停止运行。因此,强烈建议 pipeline 尽可能在 agent 容器中运行外部命令。

如果Project配额允许,请参阅 Jenkins 文档中关于 Jenkins master 从内存角度应该具备什么的建议。这些建议规定为 Jenkins master 分配更多内存。

建议为 Jenkins Kubernetes 插件创建的 agent 容器指定内存请求和限制值。管理员用户可以通过 Jenkins 配置为每个 agent 镜像设置默认值。内存请求和限制参数也可以在每个容器的基础上覆盖。

您可以通过在实例化 Jenkins Ephemeral 或 Jenkins Persistent 模板时覆盖MEMORY_LIMIT参数来增加 Jenkins 可用内存量。