全部產品
Search
文件中心

Enterprise Distributed Application Service:使用toolkit-maven-plugin外掛程式升級應用(ECS叢集)

更新時間:Jun 30, 2024

您可以使用toolkit-maven-plugin外掛程式升級已經部署在EDAS的Spring Cloud、Dubbo和HSF應用。

前提條件

已在EDAS建立Spring Cloud、Dubbo和HSF應用。

背景資訊

toolkit-maven-plugin是一個開源工具,協助您構建一個應用完整的生命週期架構,完成專案的基礎工具建設。更多資訊,請參見toolkit-maven-plugin概述

toolkit-maven-plugin也支援升級EDAS K8s叢集中的應用。具體操作,請參見使用Cloud Toolkit外掛程式單批發布應用(K8s)

操作步驟

  1. 在本地應用工程的pom.xml檔案中,添加toolkit-maven-plugin外掛程式的依賴。

    <build>
        <plugins>
            <plugin>
                <groupId>com.alibaba.cloud</groupId>
                <artifactId>toolkit-maven-plugin</artifactId>
                <version>1.1.5</version>
            </plugin>
        </plugins>
    </build>                      
    說明

    version的值建議設定為1.1.5,最新版本可能存在不適用情況。

  2. 在工程的根目錄下,建立設定檔.edas_config.yaml,在檔案中配置部署參數。

    • .開頭的檔案為IDE的預設設定檔。在未指定其它設定檔時,外掛程式會預設使用根目錄下的.edas_config.yaml檔案。

    • 如果建立了非.開頭的設定檔,也可以在打包工程時,通過設定參數-Dedas_config=xxx來指定該設定檔。

    • 如果存在預設設定檔,也通過參數指定了其它設定檔,那麼外掛程式會使用參數指定的設定檔。

    說明

    如果當前工程為一個Maven工程的子模組,那麼預設設定檔應該存放在當前工程目錄下,而不是整個Maven工程的根目錄下。關於多模組工程部署更多方式,請參見部署多模組工程

    典型升級情境的配置樣本如下:

    • 升級應用所有分組。

      例如,在華北2(北京)地區有一個ID為eb20****-e6ee-4f6d-a36f-5f6a5455****的應用,需要升級該應用的所有分組。配置樣本如下:

      env:
           region_id: cn-beijing
      app:
           app_id: eb20****-e6ee-4f6d-a36f-5f6a5455****                        

      配置參數的值請以應用相關的實際資訊為準。

    • 升級應用指定分組並標識部署套件版本。

      例如,在華北2(北京)地區有一個ID為eb20dc8a-e6ee-4f6d-a36f-5f6a545****的應用,需要升級的應用分組ID為06923bb9-8c5f-4508-94d8-517b692f****,部署套件版本為1.2。配置樣本如下:

      env:
        region_id: cn-beijing
      app:
        app_id: eb20dc8a-e6ee-4f6d-a36f-5f6a5455****
        package_version: 1.2
        group_id: 06923bb9-8c5f-4508-94d8-517b692f****            

    實際使用時,可能會有更複雜的情境,需要配置更多參數,請參見部署應用配置參數說明

  3. 在本地建立一個YAML帳號檔案,在檔案中配置AccessKey IDAccessKey Secret

    推薦使用RAM使用者(需已授予應用管理許可權)的AccessKey IDAccessKey Secret,以便控制應用許可權來提高應用的安全性。RAM使用者的AccessKey IDAccessKey Secret可以在阿里雲AccessKey管理頁面查看。

    帳號檔案樣本如下:

    access_key_id:yourAccessKeyId
    access_key_secret:yourAccessKeySecret
    說明

    代碼中的yourAccessKeyIdyourAccessKeySecret請替換成您實際的AccessKey IDAccessKey Secret。該配置中AccessKey IDAccessKey Secret只會用來產生請求籤名,不用於網路傳輸等其他用途。

  4. 在本地工程目錄(如果為Maven多模組則進入子模組目錄),執行以下命令,將應用打包並部署到EDAS。

    mvn clean package toolkit:deploy -Daccess_key_file={帳號檔案路徑}                        

    命令參數說明:

    • toolkit:deploy: 使用toolkit-maven-plugin外掛程式部署應用的參數。只有添加此參數,才會在應用打包成功後進行部署。

    • access_key_file:帳號檔案路徑參數。

      說明

      更多指定金鑰組的方式,請參見帳號配置及帳號優先順序說明

    • -Djar_path:通過設定該參數指定部署套件檔案路徑,跳過打包步驟而直接使用已有的部署套件進行部署。部署套件路徑支援絕對路徑和相對路徑。

      mvn toolkit:deploy -Daccess_key_file={帳號檔案路徑} -Djar_path=target/demo.jar                        
      重要

      您還可以在env中配置帳號檔案路徑,請參見部署應用配置參數說明,上述-D方式優先順序大於env中的配置。

結果驗證

  1. 執行應用打包、部署命令後,在IDE的Terminal中查看輸出日誌。

    • 顯示以下資訊,並提示BUILD SUCCESS,表示應用部署成功。EDAS成功使用toolkit-maven-plugin部署了應用

    • 如果輸出日誌中包含ERROR相關資訊,請根據日誌排查失敗原因。解決後再重新部署。

  2. 登入EDAS控制台,查看變更記錄應用詳情,檢查應用是否升級(部署)成功。更多操作,請參見結果驗證

專有雲支援

toolkit-maven-plugin外掛程式可以在專有雲企業版V3.8.0及以上版本使用,在使用前需要在外掛程式中配置EDAS Endpoint。相關配置,請參見部署應用配置參數說明。請聯絡EDAS支援人員擷取Endpoint。