流水线常见问题

在触发 CI / CD 流水线时可能会因为一些其它因素造成流水线运行失败,比如凭证信息填写错误或网络问题等这类不确定的原因。在流水线运行失败时,用户应该如何排错呢?

如何查看日志

在大多时间用户可以直接通过 Pipeline 的图形化页面查看日志完成排错,通常您执行命令的错误信息会在 Pipeline 的每个 Stage 的日志中。如下执行了一个不存在的 Shell 命令,错误信息位于每个 Stage 的日志中。

查看流水线日志

但是在部分情况下,错误的参数可能导致 Jenkins Pipeline 的异常中断,这时错误的日志在 Stage 日志中可能不会展示,需要用户使用流水线的下载日志下载整个 Pipeline 的完整日志。

例如下面这种情况,我们在使用 Pipeline Step 时传入了非法的参数,这种情况下部分 Step 可能会发生异常,但这种异常可能不会在 Stage 日志中展示。用户可以点击 下载日志 获取 Pipeline 的完整日志进行排错。

下载日志

重新执行与运行之间的区别

重新执行将尽力还原 Pipeline 运行时所在的运行环境。尽管每次 Pipeline 运行完毕后整个 Agent 环境将被销毁,但是 Jenkins 将 Pipeline 运行时所在的 SCM 环境与环境变量、参数变量以及 Jenkinsfile 信息都进行存储,在重新运行时将加载上次运行的环境,因此提供了几乎一致的运行环境。运行将重新触发一次运行,将刷新所有环境,根据用户的配置生成全新的环境。 重新执行 按钮位于运行图形化展示页的左侧。

重新执行

Jenkins 语言支持问题

KubeSphere 拥有很多母语为中文的用户,但是 Jenkins 目前对中文以及一些需要 UTF-8 字符集的语言支持度不是很好,因此强烈建议您在使用 KubeSphere Devops 时 (如命名或添加参数) 尽量使用英文。

其他错误

在运行 Pipeline 时,我们需要用户配置 credential 以获得推送到 DockerHub、Git 仓库的权限。需要注意的是 Git 仓库的密码是在 http 链接中直接进行了使用,若用户的凭证信息如密码中包含了 @$ 这类符号,可能在运行时无法识别而报错,当遇到这类情况需要用户在创建 credential 时对密码进行 urlencode 编码,可通过一些第三方网站进行转换 (比如 http://tool.chinaz.com/tools/urlencode.aspx)。

在 Agent 中切换工作空间

目前 dirws 命令都不能在 Kubernetes Agent 中切换到 /home/jenkins/ 外的目录,如果需要切换到 /home/jenkins/ 外的目录并执行命令,您可以使用 cd 命令进行目录的切换。例如: cd /usr/ && ls

这是 Jenkins Kubernetes Plugin 一个已知的问题,我们会跟进社区后续修复。

示例运行失败如何排错

快速入门中的示例六和示例七用到的 devops-docs-sample 代码仓库位于 GitHub 之中,并且 Pipeline 运行过程需要拉取项目所需的 npm 依赖,同时 sample 还将构建完成的镜像推往 DockerHub,这些仓库的服务端都在国外,因此该示例对执行网络环境有比较严格的要求。如果 devops-docs-sample 运行失败,同样可以通过查看 Pipeline 日志来获取完整的错误信息,以定位问题。

如何解决网络问题

对于网络错误,可以通过重新运行来尝试解决。如果多次重新运行后不能解决这个问题,可以通过将源代码仓库、Docker 镜像仓库转移到国内的方法进行解决。

国内许多 SCM 服务的提供商都提供一键导入 GitHub Repo 的功能,用户只需下载示例源代码的仓库,通过国内的 SCM 服务商来完成仓库的转移。

下载源码

对于自建的 SCM 服务,可以通过下面几个步骤来进行迁移。

1、在工作目录初始化一个 Git 仓库,并在自建 SCM 中使两者关联。

2、下载源代码仓库的 zip 压缩包,并将压缩包的内容解压到 Git 仓库目录中。

3、将例子代码提交并推送到自建 SCM 中。

4、创建 Git 类型的项目,并填入自建 SCM 仓库中的例子信息。

5、镜像仓库替换需要修改 Jenkinsfile 的中 docker build、docker tag、docker push 命令的镜像名称,以及示例仓库中 /deploy 的 yaml 文件中的镜像地址,用户可以按照自己的情况进行镜像仓库地址的修改。

内置 Maven agent 构建缓慢

在默认情况下,我们将 Maven agent 的 JVM 设置为 32 位以降低构建所造成的内存消耗。

在 32 位的 JVM 当中,最大堆大小不能超过 2G ,对于一些大型项目来说会造成构建无法完成、构建缓慢等情况。

可以在 Jenkinsfile 当中主动运行以下命令,将 agent 的 JVM 切换至 64 位:

$ alternatives --set java /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.191.b12-0.el7_5.x86_64/jre/bin/java
$ alternatives --set javac /usr/lib/jvm/java-1.8.0-openjdk-1.8.0.191.b12-0.el7_5.x86_64/bin/javac
流水线常见问题
如何查看日志
重新执行与运行之间的区别
Jenkins 语言支持问题
其他错误
在 Agent 中切换工作空间
示例运行失败如何排错
如何解决网络问题
内置 Maven agent 构建缓慢