在Jenkins中配置GitLab SSH访问的详细指南（注意jenkins服务器上切换用户的坑）
个人名片
🎓作者简介：java领域优质创作者
🌐个人主页：码农阿豪
📞工作室：新空间代码工作室（提供各种软件服务）
💌个人邮箱：[2435024119@qq.com]
📱个人微信：15279484656
🌐个人导航网站：www.forff.top
💡座右铭：总有人要赢。为什么不能是我呢？
- 专栏导航：
码农阿豪系列专栏导航
面试专栏：收集了java相关高频面试题，面试实战总结🍻🎉🖥️
Spring5系列专栏：整理了Spring5重要知识点与实战演练，有案例可直接使用🚀🔧💻
Redis专栏：Redis从零到一学习分享，经验总结，案例实战💐📝💡
全栈系列专栏：海纳百川有容乃大，可能你想要的东西里面都有🤸🌱🚀
目录
- 在Jenkins中配置GitLab SSH访问的详细指南
- 一、Jenkins与GitLab的集成
- 1.1 准备工作
- 二、生成SSH密钥对
- 2.1 生成SSH密钥
- 2.2 查看生成的密钥
- 三、将公钥添加到GitLab
- 3.1 确认密钥已添加
- 四、配置Jenkins以使用SSH密钥
- 4.1 安装Git插件
- 4.2 配置凭据
- 4.3 创建新的Jenkins任务
- 五、配置known_hosts文件
- 5.1 使用ssh-keyscan添加主机密钥
- 5.2 验证主机密钥配置
- 六、调试访问问题
- 6.1 主机密钥验证失败
- 6.2 SSH权限问题
- 七、总结
在Jenkins中配置GitLab SSH访问的详细指南
在现代软件开发中，持续集成和持续交付（CI/CD）已成为了提高开发效率和软件质量的关键手段。Jenkins作为一种流行的开源自动化服务器，广泛应用于这一领域。然而，在使用Jenkins与GitLab等版本控制系统进行集成时，SSH配置常常成为开发者面临的一个挑战。在本文中，我们将详细探讨如何在Jenkins中配置SSH公钥和私钥，以便顺利访问GitLab仓库，并解决在配置过程中可能遇到的问题。
一、Jenkins与GitLab的集成
Jenkins通过Git插件与GitLab进行集成，允许用户在构建任务中从GitLab仓库中拉取代码。为了安全地访问GitLab，使用SSH密钥是一种常见的做法。通过这种方式，开发者可以避免在脚本中明文保存用户名和密码，增强了安全性。
1.1 准备工作
在开始之前，请确保以下几点：
- Jenkins服务器已正确安装并运行。
- GitLab仓库已创建，并具有访问权限。
- 有足够的权限对Jenkins服务器进行SSH配置。
二、生成SSH密钥对
首先，我们需要为Jenkins生成一个SSH密钥对。SSH密钥对由公钥和私钥组成，公钥可以安全地存储在GitLab中，而私钥则应安全保管在Jenkins服务器上。
2.1 生成SSH密钥
在Jenkins服务器上，以Jenkins用户身份运行以下命令：
sudo su - jenkins
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
在提示中，可以选择按回车键接受默认文件路径（~/.ssh/id_rsa），并可以为密钥设置密码（可选）。
2.2 查看生成的密钥
生成后，可以查看公钥的内容：
cat ~/.ssh/id_rsa.pub
将输出的公钥复制到剪贴板中，后续需要将其添加到GitLab。
三、将公钥添加到GitLab
登录到GitLab，进入“用户设置”或“项目设置”，找到SSH密钥的部分。将之前复制的公钥粘贴到文本框中，并为其设置一个描述，然后点击“添加密钥”。
3.1 确认密钥已添加
在GitLab的SSH密钥管理页面，确认新添加的公钥在列表中。
四、配置Jenkins以使用SSH密钥
Jenkins需要配置以使用生成的SSH私钥进行Git操作。以下步骤将指导你完成这一过程。
4.1 安装Git插件
确保Jenkins中安装了Git插件。可以通过以下步骤检查：
- 登录到Jenkins。
- 转到“管理Jenkins” -> “管理插件”。
- 在“已安装”选项卡中搜索“Git Plugin”，如果未安装，则在“可选”选项卡中安装。
4.2 配置凭据
在Jenkins中添加SSH凭据，以便能够使用私钥：
- 转到“管理Jenkins” -> “凭据”。
- 在“系统”下选择“全局凭据(无域)”。
- 点击“添加凭据”。
- 在“种类”中选择“SSH Username with private key”。
- 在“用户名”中输入
git（这是GitLab的默认用户名）。 - 在“私钥”中选择“直接输入私钥”，并粘贴之前生成的私钥内容。
- 为凭据设置描述，然后点击“确定”。
4.3 创建新的Jenkins任务
- 回到Jenkins主界面，点击“新建任务”。
- 输入任务名称，选择“自由风格项目”，然后点击“确定”。
- 在“源码管理”部分选择“Git”，在“仓库URL”中输入GitLab的SSH地址，如
git@gitlabnew.1nmob.com:ad/server/ysx-adcontrol.git。 - 在“凭据”下拉菜单中选择之前添加的SSH凭据。
五、配置known_hosts文件
在使用SSH访问GitLab之前，需要确保Jenkins服务器信任GitLab的主机密钥。此时可能会遇到Host key verification failed的错误。
5.1 使用ssh-keyscan添加主机密钥
使用ssh-keyscan命令将GitLab主机密钥添加到known_hosts文件中：
ssh-keyscan gitlabnew.1nmob.com >> ~/.ssh/known_hosts
请注意，如果Jenkins以非交互式用户身份运行，确保添加的known_hosts文件是对应用户的~/.ssh/known_hosts。
5.2 验证主机密钥配置
可以通过以下命令确认主机密钥已成功添加：
cat ~/.ssh/known_hosts
如果配置正确，则应能看到对应的GitLab主机密钥。
六、调试访问问题
在配置过程中，可能会遇到一些问题，以下是一些常见错误及解决方法。
6.1 主机密钥验证失败
如果在构建任务中遇到如下错误：
Host key verification failed.
可以通过以下步骤排查：
- 确认
known_hosts文件中是否存在对应的主机密钥。 - 检查Jenkins的用户权限，确保Jenkins用户能够访问
~/.ssh/known_hosts文件。 - 尝试在
/etc/ssh/ssh_known_hosts中添加主机密钥，以便所有用户共享。
6.2 SSH权限问题
如果出现Permission denied (publickey)错误，请检查以下内容：
- 确保GitLab中添加的SSH公钥与Jenkins生成的私钥匹配。
- 确保Jenkins用户的
~/.ssh目录权限正确，通常应为700，~/.ssh/id_rsa的权限应为600。
七、总结
通过上述步骤，我们可以在Jenkins中成功配置SSH访问GitLab仓库，增强了自动化构建的安全性。以下是一些关键点的总结：
- 使用SSH密钥避免了在脚本中明文保存密码，提升了安全性。
- 确保在
known_hosts文件中添加了GitLab主机的公钥，避免主机密钥验证失败。 - 定期检查SSH密钥的安全性，确保只允许授权用户访问。
掌握这些基本知识后，您将能更好地在Jenkins中管理与GitLab的集成，构建更加安全和高效的CI/CD流程。如果在实践中遇到问题，可以参考本文所述的调试步骤进行排查。
