配置Spring Cloud Config Server连接私有GitLab repository

深藏阁楼爱情的钟 2022-12-27 12:49 123阅读 0赞

### 文章目录 ###

*  配置Spring Cloud Config Server连接私有GitLab repository
 *   *  前言
     *   *  用SSH private key properties方式连接GitLab私有repository
         *  生成JGit需要的PEM格式的RSA private key
         *  将public key添加到GitLab上
         *  在Config Server上配置private key properties
     *  参考文档

# 配置Spring Cloud Config Server连接私有GitLab repository #

## 前言 ##

Spring Cloud Config Server 支持以下几种方式连接私有GitLab repository：

*  方式一：用户名/密码方式
 *  方式二：本地SSH private key方式
 *  方式三：把SSH private key添加到Config Server properties的方式

方式一，比较简单，但是需要把明文密码暴露出来不太安全。

方式二，在Config Server运行在Kubernetes时，比较难以配置“本地SSH private key”。

方式三，比较安全，也不用担心Config Server运行在Kubernetes时读取不到SSH private key。当然用来拉取Config Repo的Git账号应该是一个只读权限的账号。

下面描述如何配置方式三。

### 用SSH private key properties方式连接GitLab私有repository ###

### 生成JGit需要的PEM格式的RSA private key ###

Spring Cloud Config Server使用JGit来访问Git repository，而**JGit需要PEM格式的RSA private key**。因此你之前的SSH private key可能不满足JGit的需要，需要重新生成。

ssh-keygen -m PEM -t rsa -b 4096

根据提示输入key名称，比如`id_rsa_config_server`。这样会生成：

*  `id_rsa_config_server` 密钥（private key）
 *  `id_rsa_config_server.pub` 公钥（public key）

### 将public key添加到GitLab上 ###

登录GitLab，打开个人设置，找到SSH keys，添加`id_rsa_config_server.pub` 公钥。

### 在Config Server上配置private key properties ###

Config Server的`bootstrap.yaml`示例：

spring:
      application:
        name: config-server
      cloud:
        config:
          server:
            git:
              uri: ssh://git@gitlab.example.com:22/yourgroup/config-repo.git
              clone-on-start: true
              default-label: main
              force-pull: true
              ignoreLocalSshSettings: true
              strictHostKeyChecking: false
              privateKey: | -----BEGIN RSA PRIVATE KEY----- xxx -----END RSA PRIVATE KEY-----

说明：

*  `uri` 为GitLab repository的SSH URL。**不要少了`ssh://`**，不然会报错“com.jcraft.jsch.JSchException: Auth fail“
 *  `default-label` 为默认分支，这里是`main`分支，如果GitLab repository是`master`分支，则需要相应修改。
 *  `ignoreLocalSshSettings: true` 忽略本地SSH private key。
 *  `strictHostKeyChecking: false` 不检查host key。加上这个配置后，不需要再配置`hostKey`和`hostKeyAlgorithm`
 *  `privateKey` 为SSH private key的内容，**注意后面一定要跟着`|` 表示该属性值为多行**，再换行输入SSH private key的内容。

## 参考文档 ##

*  [https://cloud.spring.io/spring-cloud-config/reference/html/\#\_authentication][https_cloud.spring.io_spring-cloud-config_reference_html_authentication]
 *  [https://cloud.spring.io/spring-cloud-config/reference/html/\#\_git\_ssh\_configuration\_using\_properties][https_cloud.spring.io_spring-cloud-config_reference_html_git_ssh_configuration_using_properties]
 *  [Yaml syntax][]

[https_cloud.spring.io_spring-cloud-config_reference_html_authentication]: https://cloud.spring.io/spring-cloud-config/reference/html/#_authentication
[https_cloud.spring.io_spring-cloud-config_reference_html_git_ssh_configuration_using_properties]: https://cloud.spring.io/spring-cloud-config/reference/html/#_git_ssh_configuration_using_properties
[Yaml syntax]: https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html#yaml-syntax

发表评论取消回复

表情：

评论列表（有 0 条评论，123人围观）

还没有评论，来说两句吧...

相关阅读

相关配置Spring Cloud Config Server连接私有GitLab repository

文章目录配置Spring Cloud Config Server连接私有GitLab repository 前言用SSH pri

深藏阁楼爱情的钟/ 2022年12月27日 12:49/ 0 赞/ 124 阅读

相关 Spring-cloud Config Server 3种配置方式

1、config 默认Git加载通过spring.cloud.config.server.git.uri指定配置信息存储的git地址，比如：https://github.

电玩女神/ 2022年09月04日 07:50/ 0 赞/ 15 阅读

相关 Spring Cloud Config Server

> Spring Cloud Config provides server and client-side support for externalized configura

矫情吗；*/ 2022年06月13日 11:23/ 0 赞/ 127 阅读

相关 spring cloud-学习之路(二):搭建一个config repository 和config server

配置文件仓库一般建一个文件夹方便管理配置文件,其实不建文件夹也可以. 这里我就按照自己已经做好的贡献给大家,有任何疑问欢迎叨扰! 1.新建一个仓库 properties文

我就是我/ 2022年06月04日 00:26/ 0 赞/ 158 阅读

相关 Spring cloud config server can not clone or checkout repository

今天在练习Spring Cloud Config Server的demo时遇到一个很“愚蠢”的问题： > Cannot clone or checkout repositor

素颜马尾好姑娘i/ 2022年05月25日 04:09/ 0 赞/ 55 阅读

相关 Spring Cloud Config Server 和Client 基本配置

官网：[http://cloud.spring.io/spring-cloud-config/single/spring-cloud-config.html\\_quick\

墨蓝/ 2022年05月16日 11:50/ 0 赞/ 194 阅读

相关 spring-cloud配置config server配置中心

在spring cloud项目中，都会配置一个配置中心去管理各个服务的配置文件，而往往配置文件不会放到本地配置中心，一般都会放到git上，下面配置一个服务如何从配置中心读取文件

偏执的太偏执、/ 2022年04月23日 01:28/ 0 赞/ 279 阅读

相关 Spring Cloud学习--spring cloud config server 获取配置过程

在上一篇博客[《Spring Cloud学习--spring cloud config配置中心》][Spring Cloud_--spring cloud config] 中我

小鱼儿/ 2022年03月25日 09:14/ 0 赞/ 534 阅读

相关 Spring Cloud - 2 (Spring Cloud Config Server)

构建Spring Cloud配置服务器实现步骤： 1. 在Configuration Class标记@EnableConfigServer 2

短命女/ 2021年11月29日 09:40/ 0 赞/ 246 阅读

相关 Spring Cloud之config server(配置中心)

Spring Cloud之config server(配置中心) Spring Cloud之config server（上）前言在spring cloud项目中，都会...

朱雀/ 2020年11月28日 17:15/ 0 赞/ 826 阅读