歡迎訪問我的GitHub

https://github.com/zq2599/blog_demos
內容：所有原創文章分類匯總及配套源碼，涉及Java、Docker、Kubernetes、DevOPS等；

關於GitLab CI

如下圖所示，開發者將代碼提交到GitLab后，可以觸發CI腳本在GitLab Runner上執行，通過編寫CI腳本我們可以完成很多使用的功能：編譯、構建、生成docker鏡像、推送到私有倉庫等：

本次實戰內容

今天咱們會一起完成以下操作：

1. 部署minio，pipeline腳本中的cache功能由minio來實現；
2. 配置和部署GitLab Runner；
3. 編寫和運行pipeline腳本；

環境和版本信息

本次實戰涉及到多個服務，下面給出它們的版本信息供您參考：

1. GitLab：Community Edition 13.0.6
2. GilLab Runner：13.1.0
3. kubernetes：1.15.3
4. Harbor：1.1.3
5. Minio：2020-06-18T02:23:35Z
6. Helm：2.16.1

需要提前準備好的服務

以下服務需要您在實戰前提前準備好：

1. 部署好GitLab，參考《群暉DS218+部署GitLab》
2. 部署好Harbor，參考《群暉DS218+部署Harbor(1.10.3)》
3. 部署好Helm，參考《部署和體驗Helm(2.16.1版本)》

準備完畢后開始實戰；

部署minio

minio作為一個獨立的服務部署，我將用docker部署在服務器：192.168.50.43

1. 在宿主機準備兩個目錄，分別存儲minio的配置和文件，執行以下命令：

mkdir -p /var/services/homes/zq2599/minio/gitlab_runner \
&& chmod -R 777 /var/services/homes/zq2599/minio/gitlab_runner \
&& mkdir -p /var/services/homes/zq2599/minio/config \
&& chmod -R 777 /var/services/homes/zq2599/minio/config

1. 執行docker命令創建minio服務，指定服務端口是9000，並且指定了access key(最短三位)和secret key(最短八位)：

sudo docker run -p 9000:9000 --name minio \
-d --restart=always \
-e "MINIO_ACCESS_KEY=access" \
-e "MINIO_SECRET_KEY=secret123456" \
-v /var/services/homes/zq2599/minio/gitlab_runner:/gitlab_runner \
-v /var/services/homes/zq2599/minio/config:/root/.minio \
minio/minio server /gitlab_runner

1. 瀏覽器訪問，輸入access key和secret key后登錄成功：
2. 如下圖，點擊紅框中的圖標，創建一個bucket，名為runner：
3. 至此，minio已備好，接下來在kubernetes環境部署GitLab Runner；

GitLab Runner的類型

從使用者的維度來看，GitLab Runner的類型分為shared和specific兩種：

1. 如果您想創建的GitLab Runner給所有GitLab倉庫使用，就要創建shared類型；
2. 如果您的GitLab Runner只用於給某個固定的Gitlab倉庫，就要創建specific類型；

今天的實戰，我們創建的是specific類型，即先有GitLab代碼倉庫，然後創建該倉庫專用的runner，所以請您提前準備好GitLab倉庫；

準備GitLab配置信息(specific)

在部署GitLab Runner之前，要準備兩個關鍵的配置信息，以便GitLab Runner啟動后可以順利連接上GitLab：

1. 瀏覽器訪問GitLab，打開用來做CI的代碼倉庫，點擊Settings -> CI/CD -> Runners -> Expand：
2. 如下圖，紅框1中是gitlab url，紅框2中是registration token，記好這兩個參數，稍後會用到：

準備GitLab配置信息(shared)

本次實戰不會創建shared類型的runner，如果您要創建該類型runner，只需按照以下方法準備信息即可，創建出來的runner就是所有倉庫都能使用的了：

1. 以管理員身份登錄GitLab；
2. 按照下圖紅框的順序取得gitlab url和registration token：

部署RitLab Runner

1. 請確保當前可以通過kubectl命令在kubernetes進行常規操作；
2. 創建名為gitlab-runner的namespace：

kubectl create namespace gitlab-runner

1. 創建一個secret，把minio的access key和secret key存進去，在後面配置cache的時候會用到：

kubectl create secret generic s3access \
--from-literal=accesskey="access" \
--from-literal=secretkey="secret123456" -n gitlab-runner

1. 用helm部署GitLab Runner之前，先把chart的倉庫添加到helm的倉庫列表中：

helm repo add gitlab https://charts.gitlab.io

1. 下載GitLab Runner的chart：

helm fetch gitlab/gitlab-runner

1. 當前目錄會多出一個文件gitlab-runner-0.18.0.tgz，解壓：

tar -zxvf gitlab-runner-0.18.0.tgz

1. 解壓后是名為gitlab-runner的文件夾，內容如下圖所示，接下來要修改裏面的三個文件：
2. 打開values.yaml，裏面有四處需要修改：
3. 第一處，找到已被註釋掉的gitlabUrl參數位置，添加gitlabUrl的配置，其值就是前面在GitLab網頁取得的gitlab url參數，如下圖紅框：
4. 第二處，找到已被註釋掉的runnerRegistrationToken參數位置，添加runnerRegistrationToken的配置，其值就是前面在GitLab網頁取得的registration token參數，如下圖紅框：
5. 找到rbac的配置，將create和clusterWideAccess的值都改成true(創建RBAC、創建容器gitlab-bastion用於管理job的容器)：
6. 設置此GitLab Runner的tag為k8s，在pipeline腳本中可以通過指定tag為k8s，這樣pipeline就會在這個Gitlab Runner上允許：
7. 找到cache的配置，在修改之前，cache的配置如下圖，可見值為空內容的大括號，其餘信息全部被註釋了：
8. 修改后的cache配置如下圖，紅框1中原先的大括號已去掉，紅框2中的是去掉了註釋符號，內容不變，紅框3中填寫的是minio的訪問地址，紅框4中的是去掉了註釋符號，內容不變：
9. 上圖紅框4中的s3CacheInsecure參數等於false表示對minio的請求為http(如果是true就是https)，但實際證明，當前版本的chart中該配置是無效的，等到運行時還是會以https協議訪問，解決此問題的方法是修改templates目錄下的_cache.tpl文件，打開此文件，找到下圖紅框中的內容：
10. 將上圖紅框中的內容替換成下面紅框中的樣子，即刪除原先的if判斷和對應的end這兩行，直接給CACHE_S3_INSECURE賦值：
11. 接下來要修改的是templates/configmap.yaml文件，在這裏面將宿主機的docker的sock映射給runner executor，這樣job中的docker命令就會發到宿主機的docker daemon上，由宿主機來執行，打開templates/configmap.yaml，找到下圖位置，我們要在紅框1和紅框2之間添加一段內容：
12. 要在上圖紅框1和紅框2之間添加的內容如下：

cat >>/home/gitlab-runner/.gitlab-runner/config.toml <<EOF
            [[runners.kubernetes.volumes.host_path]]
              name = "docker"
              mount_path = "/var/run/docker.sock"
              read_only = true
              host_path = "/var/run/docker.sock"
    EOF

1. 添加上述內容后，整體效果如下，紅框中就是新增內容：
2. 修改完畢，回到values.yam所在目錄，執行以下命令即可創建GitLab Runner：

helm install \
--name-template gitlab-runner \
-f values.yaml . \
--namespace gitlab-runner

1. 檢查pod是否正常：
2. 看pod日誌也並未發現異常：
3. 回到GitLab的runner頁面，可見新增一個runner：

   至此，整個GitLab CI環境已部署完畢，接下來簡單的驗證環境是否OK；

驗證

1. 在GitLab倉庫中，增加名為.gitlab-ci.yml的文件，內容如下：

# 設置執行鏡像
image: busybox:latest

# 整個pipeline有兩個stage
stages:
- build
- test

# 定義全局緩存，緩存的key來自分支信息，緩存位置是vendor文件夾
cache:
  key: ${CI_COMMIT_REF_SLUG}
  paths:
  - vendor/

before_script:
  - echo "Before script section"

after_script:
  - echo "After script section"

build1:
  stage: build
    tags:
  - k8s
  script:
    - echo "將內容寫入緩存"
    - echo "build" > vendor/hello.txt

test1:
  stage: test
  script:
    - echo "從緩存讀取內容"
    - cat vendor/hello.txt

1. 提交上述腳本到GitLab，如下圖，可見pipeline會被觸發，狀態為pending是因為正在等待runner創建executor pod：
2. 稍後就會執行成功，點開看結果：
3. 點開build1的圖標，可見此job的輸出信息：
4. 點開test1的圖標，可見對應的控制台輸出，上一個job寫入的數據被成功讀取：

   至此，GitLab Runner已經成功在kubernetes環境部署和運行，接下來的文章，我們會一起實戰將SpringBoot應用構建成docker鏡像並推送到Harbor；

歡迎關注我的公眾號：程序員欣宸

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※網頁設計一頭霧水該從何著手呢? 台北網頁設計公司幫您輕鬆架站!

※網頁設計公司推薦不同的風格，搶佔消費者視覺第一線

※想知道購買電動車哪裡補助最多?台中電動車補助資訊懶人包彙整

※南投搬家公司費用,距離,噸數怎麼算?達人教你簡易估價知識!

※教你寫出一流的銷售文案?

※超省錢租車方案

一、背景

在微服務架構中 API網關 非常重要，網關作為全局流量入口並不單單是一個反向路由，更多的是把各個邊緣服務(Web層)的各種共性需求抽取出來放在一個公共的“服務”(網關)中實現，例如安全認證、權限控制、限流熔斷、監控、跨域處理、聚合API文檔等公共功能。

 

在以 Dubbo 框架體系來構建的微服務架構下想要增加API網關，如果不想自研開發的情況下在目前的開源社區中幾乎沒有找到支持dubbo協議的主流網關，但是 Spring Cloud 體系下卻有兩個非常熱門的開源API網關可以選擇；本文主要介紹如何通過 Nacos 整合 Spring Cloud Gateway 與 Dubbo 服務。

 

二、傳統 dubbo 架構

dubbo屬於rpc調用，所以必須提供一個web層的服務作為http入口給客戶端調用，並在上面提供安全認證等基礎功能，而web層前面對接Nginx等反向代理用於統一入口和負載均衡。

web層一般是根據業務模塊來切分的，用於聚合某個業務模塊所依賴的各個service服務

PS：我們能否把上圖中的web層全部整合在一起成為一個API網關呢？(不建議這樣做)

因為這樣的web層並沒有實現 泛化調用 必須引入所有dubbo服務的api依賴，會使得網關變得非常不穩定，任何服務的接口變更都需要修改網關中的api依賴！

 

三、整合 Srping Cloud Gateway 網關

下面就開始聊聊直接拿熱門的 Srping Cloud Gateway 來作為dubbo架構體系的網關是否可行，首先該API網關是屬於 Spring Cloud 體系下的組件之一，要整合dubbo的話需要解決以下問題：

1. 打通註冊中心：spring cloud gateway 需要通過註冊中心發現下游服務，而 dubbo 也需要通過註冊中心實現服務的註冊與發現，如果兩者的註冊中心不能打通的話就會變成雙註冊中心架構就非常複雜了！
2. 協議轉換： gateway 使用http傳輸協議調用下游服務，而dubbo服務默認使用的是tcp傳輸協議

上面提到的第一個問題“打通註冊中心”其實已經不是問題了，目前dubbo支持 Zookeeper 與 Nacos 兩個註冊中心，而 Spring Cloud 自從把 @EnableEurekaClient 改為 @EnableDiscoveryClient 之後已經基本上支持所有主流的註冊中心了，本文將使用 Nacos 作為註冊中心打通兩者

 

3.1. 方式一

把傳統dubbo架構中的 Nginx 替換為 Spring Cloud Gateway ，並把 安全認證 等共性功能前移至網關處實現

由於web層服務本身提供的就是http接口，所以網關層無需作協議轉換，但是由於 安全認證 前移至網關了需要通過網絡隔離的手段防止被繞過網關直接請求後面的web層

 

3.2. 方式二

dubbo服務本身修改或添加 rest 傳輸協議的支持，這樣網關就可以通過http傳輸協議與dubbo服務通信了

rest傳輸協議：基於標準的Java REST API——JAX-RS 2.0（Java API for RESTful Web Services的簡寫）實現的REST調用支持

目前版本的dubbo已經支持dubbo、rest、rmi、hessian、http、webservice、thrift、redis等10種傳輸協議了，並且還支持同一個服務同時定義多種協議，例如配置 protocol = { “dubbo”, “rest” } 則該服務同時支持 dubbo 與 rest 兩種傳輸協議

 

3.3. 總結

方式一 對比 方式二 多了一層web服務所以多了一次網絡調用開銷，但是優點是各自的職責明確單一，web層可以作為聚合層用於聚合多個service服務的結果經過融合加工一併返回給前端，所以這種架構下能大大減少服務的 循環依賴

 

四、代碼實踐

依賴環境

• lombok
• jdk 1.8
• Nacos 1.3
• Spring Boot 2.2.8.RELEASE
• Spring Cloud Hoxton.SR5
• Spring Cloud Alibaba 2.2.1.RELEASE

 

在根目錄的 pom.xml 中定義全局的依賴版本

    <properties>
        <maven.compiler.source>1.8</maven.compiler.source>
        <maven.compiler.target>1.8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <java.version>8</java.version>

        <spring-boot-dependencies.version>2.2.8.RELEASE</spring-boot-dependencies.version>
        <spring-cloud-dependencies.version>Hoxton.SR5</spring-cloud-dependencies.version>
        <spring-cloud-alibaba-dependencies.version>2.2.1.RELEASE</spring-cloud-alibaba-dependencies.version>
        <jaxrs.version>3.12.1.Final</jaxrs.version>
    </properties>

    <dependencyManagement>
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-dependencies</artifactId>
                <version>${spring-boot-dependencies.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>${spring-cloud-dependencies.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>

            <dependency>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>spring-cloud-alibaba-dependencies</artifactId>
                <version>${spring-cloud-alibaba-dependencies.version}</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
        </dependencies>
    </dependencyManagement>

 

4.1. 創建dubbo-api工程

分別定義兩個api接口

DubboService 使用dubbo協議的服務

public interface DubboService {
    String test(String param);
}

RestService 使用rest協議的服務

public interface RestService {
    String test(String param);
}

 

4.2. 創建web-dubbo工程

使用 方式一 整合對接網關，這裏為了簡化在同一個服務下只使用邏輯分層定義controller層與service層，並沒有做服務拆分

4.2.1. 創建配置

定義 spring boot 配置

server:
  port: 8081

spring:
  application:
    name: zlt-web-dubbo
  main:
    allow-bean-definition-overriding: true
  cloud:
    nacos:
      server-addr: 192.168.28.130:8848
      username: nacos
      password: nacos

server.port：配置應用服務器暴露的端口

spring.cloud.nacos：配置 spring cloud 的註冊中心相關參數，nacos 的配置需要改為自己環境所對應

定義 dubbo 配置

dubbo:
  scan:
    base-packages: org.zlt.service
  protocols:
    dubbo:
      name: dubbo
      port: -1
  registry:
    address: spring-cloud://localhost
  consumer:
    timeout: 5000
    check: false
    retries: 0
  cloud:
    subscribed-services:

dubbo.scan.base-packages：指定 Dubbo 服務實現類的掃描基準包

dubbo.protocols：服務暴露的協議配置，其中子屬性 name 為協議名稱，port 為協議端口（ -1 表示自增端口，從 20880 開始）

dubbo.registry.address：Dubbo 服務註冊中心配置，其中子屬性 address 的值 “spring-cloud://localhost”，說明掛載到 Spring Cloud 註冊中心

 

4.2.2. 創建DubboService的實現類

通過 protocol = "dubbo" 指定使用 dubbo協議 定義服務

@Service(protocol = "dubbo")
public class DubboServiceImpl implements DubboService {
    @Override
    public String test(String param) {
        return "dubbo service: " + param;
    }
}

 

4.2.3. 創建Controller類

使用 Spring Boot 的 @RestController 註解定義web服務

@RestController
public class WebController {
    @Autowired
    private DubboService dubboService;

    @GetMapping("/test/{p}")
    public String test(@PathVariable("p") String param) {
        return dubboService.test(param);
    }
}

 

4.3. 創建rest-dubbo工程

使用 方式二 整合對接網關，由於該服務是通過dubbo來創建rest服務，所以並不需要使用 Spring Boot 內置應用服務

4.3.1. 創建配置

定義 spring boot 配置

spring:
  application:
    name: zlt-rest-dubbo
  main:
    allow-bean-definition-overriding: true
  cloud:
    nacos:
      server-addr: 192.168.28.130:8848
      username: nacos
      password: nacos

因為不使用 Spring Boot 內置的應用服務所以這裏並不需要指定 server.port

定義 dubbo 配置

dubbo:
  scan:
    base-packages: org.zlt.service
  protocols:
    dubbo:
      name: dubbo
      port: -1
    rest:
      name: rest
      port: 8080
      server: netty
  registry:
    address: spring-cloud://localhost
  consumer:
    timeout: 5000
    check: false
    retries: 0
  cloud:
    subscribed-services:

dubbo.protocols：配置兩種協議，其中rest協議定義 8080 端口並使用 netty 作為應用服務器

 

4.3.2. 創建RestService的實現類

通過 protocol = "rest" 指定使用 rest協議 定義服務

@Service(protocol = "rest")
@Path("/")
public class RestServiceImpl implements RestService {
    @Override
    @Path("test/{p}")
    @GET
    public String test(@PathParam("p") String param) {
        return "rest service: " + param;
    }
}

 

4.4. 創建Spring Cloud Gateway工程

定義 spring boot 配置

server:
  port: 9900

spring:
  application:
    name: sc-gateway
  main:
    allow-bean-definition-overriding: true
  cloud:
    nacos:
      server-addr: 192.168.28.130:8848
      username: nacos
      password: nacos

server.port：定義網關端口為 9090

定義網關配置

spring:
  cloud:
    gateway:
      discovery:
        locator:
          lowerCaseServiceId: true
          enabled: true
      routes:
        - id: web
          uri: lb://zlt-web-dubbo
          predicates:
            - Path=/api-web/**
          filters:
            - StripPrefix=1
        - id: rest
          uri: lb://zlt-rest-dubbo
          predicates:
            - Path=/api-rest/**
          filters:
            - StripPrefix=1

分別定義兩個路由策略：

• 路徑 /api-web/ 為請求 web-dubbo 工程
• 路徑 /api-rest/ 為請求 rest-dubbo 工程

 

4.5. 測試

分別啟動：Nacos、sc-gateway、web-dubbo、rest-dubbo 工程，通過網關的以下兩個接口分別測試兩種整合方式

1. http://127.0.0.1:9900/api-web/test/abc ：請求 web-dubbo 工程測試整合方式一
2. http://127.0.0.1:9900/api-rest/test/abc ：請求 rest-dubbo 工程測試整合方式二

 

五、demo下載

ide需要安裝 lombok 插件

https://github.com/zlt2000/dubboSpringCloud

 
掃碼關注有驚喜！

本站聲明:網站內容來源於博客園,如有侵權,請聯繫我們,我們將及時處理

【其他文章推薦】

※網頁設計一頭霧水該從何著手呢? 台北網頁設計公司幫您輕鬆架站!

※網頁設計公司推薦不同的風格，搶佔消費者視覺第一線

※想知道購買電動車哪裡補助最多?台中電動車補助資訊懶人包彙整

※南投搬家公司費用,距離,噸數怎麼算?達人教你簡易估價知識!

※教你寫出一流的銷售文案?

※超省錢租車方案