程式碼部署

上次更新: 2024-01-29
  • 建立對象:
  • Admin

了解如何部署您的程式碼以及部署時 Cloud Manager 中會發生什麼情況。

使用 Cloud Manager 部署程式碼

設定好生產管道 (包括必要的存放庫和環境) 後,您就可以準備部署程式碼了。

  1. 從 Cloud Manager 按一下​部署,即可開始部署流程。

    部署按鈕

  2. 會顯示​管道執行​畫面。按一下​建置,即可開始流程。

    建置按鈕

建置流程會啟動程式碼部署流程,包括以下步驟:

  • 中繼部署
  • 中繼測試
  • 生產部署

您可以透過檢視紀錄或檢閱測試標準的結果來查看各種部署流程的步驟。

部署步驟

在部署的每個步驟中都會發生許多操作,本節將對此進行說明。如需有關如何在幕後部署程式碼本身的技術細節,請參閱部署流程詳細資訊一節。

中繼部署步驟

此​中繼部署​步驟包括下列操作:

  • 驗證:此步驟會確保將管道設定為使用目前可用的資源,例如存在已設定的分支以及環境可供使用。
  • 建置及單位測試:此步驟會執行容器化的建置流程。 如需詳細資訊,請參閱文件:組建環境
  • 程式碼掃描:此步驟會評估應用程式程式碼的品質。如需有關測試流程的詳細資訊,請參閱文件:了解測試結果
  • 部署至中繼

中繼部署

中繼測試步驟

此​中繼測試​步驟包括下列操作:

  • 安全測試:此步驟會評估您的程式碼對 AEM 環境的安全影響。如需有關測試流程的詳細資訊,請參閱文件:了解測試結果

    • 效能測試:此步驟會評估程式碼的效能。如需有關測試流程的詳細資訊,請參閱了解測試結果

    中繼測試

生產部署步驟

此​生產部署​步驟包括下列操作:

  • 申請核准
    • 設定管道時會啟用此選項。
    • 使用此選項,您可以進行生產部署的排程或按一下​現在,以立即執行生產部署。
  • 生產部署排程
    • 設定管道時會啟用此選項。
    • 排程的日期和時間會根據使用者的時區指定。
      排程部署
  • CSE 支援 (如啟用)
  • 部署至生產環境

生產部署

部署完成後,您的程式碼將在其目標環境中,而且您可以檢視紀錄。

部署完成

逾時

如果等候使用者回饋意見,以下步驟將逾時:

步驟 逾時
程式碼品質測試 7 天
安全測試 7 天
效能測試 7 天
申請核准 (階段) 7 天
申請核准 (生產) 14 天
生產部署排程 14 天
管理生產部署 14 天

部署流程詳細資訊

Cloud Manager 會將建置流程產生的所有 target/*.zip 檔案上傳到儲存位置。這些成品是在管道的部署階段從該位置擷取的。

當 Cloud Manager 部署到非生產拓撲時,目標是盡快完成部署,因此會將成品同時部署到所有節點,如下所示:

  1. Cloud Manager 會決定每個成品是 AEM 或是 Dispatcher 套件。

  2. Cloud Manager 會從負載平衡器中移除所有 Dispatcher,以在部署期間隔離環境。

    • 除非另有設定,否則您在開發和中繼部署中可跳過負載平衡器變更,即對於開發環境,在兩個非生產管道中分離和附加步驟,而對於中繼環境,則為生產管道。

    跳過負載平衡器

    注意

    本功能預計主要由 1-1-1 客戶使用。

  3. 每個 AEM 成品都會透過封裝管理員 API (加上決定部署順序的套件相依性) 部署到每個 AEM 執行個體,。

    • 若要了解如何使用套件安裝新功能、在執行個體之間傳輸內容以及將存放庫內容備份的詳細資訊,請參閱文件:封裝管理員。
    注意

    所有 AEM 成品都會部署給作者和發佈者。當需要節點特定的設定時,應利用運行模式。若要了解有關運行模式如何讓您能夠針對特定目的調整 AEM 執行個體的詳細資訊,請參閱「部署到 AEM as a Cloud Service」文件的「運行模式」一節。

  4. 此 Dispatcher 成品會依照以下方式部署到每個 Dispatcher:

    1. 會將目前設定備份並複製到暫時的位置。
    2. 除不可變檔案外,所有設定都將遭到刪除。如需更多詳細資訊,請參閱文件:Dispatcher 設定。這將清除目錄以確保沒有遺留孤立的檔案。
    3. 成品會被擷取至 httpd 目錄。不可變檔案並不會被覆寫。您對 Git 存放庫中不可變檔案所進行的任何變更將在部署時遭忽略。這些檔案是 AMS Dispatcher 架構的核心,且無法變更。
    4. Apache 會執行設定測試。如果未發現錯誤,則會重新載入服務。如果發生錯誤,則從備份中還原設定,重新載入服務,並將錯誤回報 Cloud Manager。
    5. 管道設定中指定的每個路徑都會無效或從 Dispatcher 快取中排清。
    注意

    Cloud Manager 期望 Dispatcher 成品包含完整的檔案集。所有 Dispatcher 設定檔案都必須在 Git 存放庫中。遺漏檔案或檔案夾將導致部署失敗。

  5. 將所有 AEM 和 Dispatcher 套件成功部署到所有節點後,會將 Dispatcher 加回負載平衡器,部署即告完成。

    注意

    您在開發和中繼部署中可跳過負載平衡器變更,即對於開發環境,在兩個非生產管道中分離和附加步驟,而對於中繼環境,則為生產管道。

部署至生產階段

為了對 AEM 網站訪客的影響降至最低,部署到生產拓撲的流程會略有不同。

生產部署通常會遵循和上述相同的步驟,但採用滾動方式:

  1. 將 AEM 套件部署給作者。
  2. 將 Dispatcher1 和負載平衡器分離。
  3. 將 AEM 套件部署到 Publish1 並同時將 Dispatcher 套件部署到 Dispatcher1,排清 Dispatcher 快取。
  4. 將 Dispatcher1 放回負載平衡器中。
  5. 一旦 Dispatcher1 重新投入使用,即會將 Dispatcher2 和負載平衡器分離。
  6. 將 AEM 套件部署到 Publish2 並同時將 Dispatcher 套件部署到 Dispatcher2,排清 Dispatcher 快取。
  7. 將 Dispatcher2 放回負載平衡器中。

本流程會一直持續到部署已經觸及拓撲中的所有發佈者和 Dispatcher 為止。

緊急管道執行模式

在危急情況下,Adobe Managed Services 客戶可能需要將程式碼變更部署到他們的中繼和生產環境,而無需等候完整的 Cloud Manager 測試週期再執行。

為了解決這些情況,可在緊急模式下執行 Cloud Manager 生產管道。使用此模式時,不執行安全性和效能測試步驟。所有其他步驟 (包括任何已設定的核准步驟) 都會按照正常管道執行模式執行。

注意

緊急管道執行模式功能會由客戶成功工程師依逐個方案啟動。

使用緊急管道執行模式

啟動生產管道執行時,如果已經為該方案啟動緊急管道執行模式功能,您可以從對話框中以正常模式或緊急模式啟動執行。

執行管道選項

以緊急模式檢視管道執行詳細資訊頁面以進行執行時,畫面最上方的階層連結會顯示指示器,表示管道正以緊急模式執行。

緊急模式階層連結

以緊急模式執行管道也能透過 Cloud Manager API 或 CLI 完成。若要以緊急模式開始執行,請使用查詢參數 ?pipelineExecutionMode=EMERGENCY 向管道的執行端點提交 PUT 請求,或者在使用 CLI 時:

$ aio cloudmanager:pipeline:create-execution PIPELINE_ID --emergency

重新執行生產部署

在極少數情況下,生產部署步驟可能會因暫時原因而失敗。在這種情況下,只要生產部署步驟已經完成,無論完成類型為何 (例如,成功、取消或失敗),系統會支援生產部署步驟的重新執行。重新執行會使用相同管道 (由三個步驟組成) 來建立新的執行。

  1. 驗證步驟 - 基本上,這和正常管道執行期間發生的驗證相同。
  2. 建置步驟 - 在重新執行的內容中,建置步驟會複製成品,而且實際上並非執行新的建置程序。
  3. 生產部署步驟 - 這會使用和正常管道執行中的生產部署步驟相同的設定和選項。

在可以重新執行的情況下,生產管道狀態頁會提供「重新執行」選項 (在一般「下載建置記錄」選項旁)。

管道概觀視窗中的重新執行選項

注意

在重新執行中,UI 會標示建置步驟,以反映這是在複製成品,而不是重新建置。

限制

  • 重新執行生產部署步驟僅適用於最後執行。
  • 重新執行不適用於復原執行或推送更新執行。
  • 如果最後執行在生產部署步驟之前的任何時候失敗,則無法重新執行。

重新執行 API

除了可在 UI 中使用之外,您還可以使用 Cloud Manager API 觸發重新執行,並且識別被觸發為重新執行的執行。

觸發重新執行

若要觸發重新執行,需要向生產部署步驟狀態的 HAL 連結 http://ns.adobe.com/adobecloud/rel/pipeline/reExecute 發出 PUT 請求。

  • 如果此連結存在,則可以從該步驟重新開始執行。
  • 如果不存在,則無法從該步驟重新開始執行。

此連結僅適用於生產部署步驟。

 {
  "_links": {
    "http://ns.adobe.com/adobecloud/rel/pipeline/logs": {
      "href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530/logs",
      "templated": false
    },
    "http://ns.adobe.com/adobecloud/rel/pipeline/reExecute": {
      "href": "/api/program/4/pipeline/1/execution?stepId=2983530",
      "templated": false
    },
    "http://ns.adobe.com/adobecloud/rel/pipeline/metrics": {
      "href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530/metrics",
      "templated": false
    },
    "self": {
      "href": "/api/program/4/pipeline/1/execution/953671/phase/1575676/step/2983530",
      "templated": false
    }
  },
  "id": "6187842",
  "stepId": "2983530",
  "phaseId": "1575676",
  "action": "deploy",
  "environment": "weretail-global-b75-prod",
  "environmentType": "prod",
  "environmentId": "59254",
  "startedAt": "2022-01-20T14:47:41.247+0000",
  "finishedAt": "2022-01-20T15:06:19.885+0000",
  "updatedAt": "2022-01-20T15:06:20.803+0000",
  "details": {
  },
  "status": "FINISHED"

HAL 連結 href 值的語法只是一個範例,實際值應隨時從 HAL 連結讀取而不是由產生取得。

如果成功,則向此端點提交 PUT 請求將導致 201 回應,而且該回應主體將是新執行的表示方式。這類似於透過 API 啟動常規執行。

識別重新執行的執行

重新執行的執行可以透過 trigger 欄位中的值 RE_EXECUTE 來識別。

本頁內容