將 Apigee Hybrid 升級至 1.17 版

這項程序涵蓋從 Apigee hybrid 1.16.x 版升級至 Apigee hybrid 1.17.3 版，以及從先前的 hybrid 1.17.x 版升級至 1.17.3 版。

子版本升級 (例如從 1.16 版升級至 1.17 版) 和修補程式版本升級 (例如從 1.17.0 版升級至 1.17.3 版) 的程序相同。

如果您是從 Apigee hybrid 1.15 版或更舊版本升級，必須先升級至 hybrid 1.16 版，才能升級至 1.17.3 版。請參閱將 Apigee Hybrid 升級至 1.16 版的操作說明。

Apigee Hybrid 1.16 版異動

請注意下列異動：

  • 支援 Model Context Protocol (MCP)：Apigee hybrid 1.17 版新增支援 Model Context Protocol (MCP)，這項開放式通訊協定可讓代理式 AI 應用程式透過代管 MCP 端點，將您的 API 做為工具使用。Apigee Hybrid 會以管理其他 API 的方式，轉送、授權及保護這些 MCP 工具呼叫，因此您不必執行或維護自己的 MCP 伺服器。詳情請參閱「Apigee 中的 Model Context Protocol (MCP) 總覽」和「MCP 快速入門導覽課程」。
  • 根 CA 憑證輪替：Apigee hybrid 1.17 版新增支援輪替根憑證授權單位 (CA) 憑證，該憑證可為執行階段元件之間的 TLS 通訊建立信任錨點。現在，您可以按照分階段輪替程序，在根 CA 到期前進行更換，而且不會停機。詳情請參閱「輪替根 CA 憑證」。
  • TLS 1.3 支援：Apigee hybrid 1.17 版新增 TLS 1.3 支援，這是傳輸層安全標準通訊協定的最新版本。與舊版 TLS 相比，TLS 1.3 的連線交握速度更快，安全性也更高。如要瞭解如何在輸入閘道上設定 TLS，請參閱「在輸入閘道上設定 TLS 和 mTLS」。
  • AI 政策支援正向 Proxy：Apigee Hybrid 1.17 版新增 AI 政策的正向 Proxy 支援，例如 Model Armor 和語意快取政策。這些政策發出的外送呼叫現在可以透過 HTTP 轉送 Proxy 轉送，這是舊版 Apigee hybrid 不支援的功能。詳情請參閱「設定 API Proxy 的轉送 Proxy」。
  • 語意快取 Private Service Connect (PSC) 端點支援：Apigee hybrid 1.17 版新增語意快取的 Private Service Connect (PSC) 端點支援。語意快取政策現在可以透過 Private Service Connect 端點連至後端服務，將流量保留在私人網路。詳情請參閱「開始使用語意快取政策」。

如要進一步瞭解 Hybrid 1.17 版的功能，請參閱「Apigee hybrid 1.17.3 版版本資訊」。

必要條件

升級至混合式 1.17 版之前，請確認安裝作業符合下列需求：

升級至 1.17.3 前 - 限制和重要注意事項

  • 升級至 Apigee hybrid 1.17 版可能需要停機。

    將 Apigee 控制器升級至 1.17.3 版時，所有 Apigee 部署作業都會進行滾動式重新啟動。如要在輪流重新啟動期間，盡可能縮短實際工作環境混合式環境的停機時間，請務必執行至少兩個叢集 (位於相同或不同的區域/資料中心)。將所有實際工作環境流量轉移至單一叢集，並將要升級的叢集離線，然後繼續升級程序。為每個叢集重複執行這項程序。

    Apigee 建議您在開始升級後，盡快升級所有叢集，降低對正式環境造成影響的可能性。第一個叢集升級後，其餘叢集並無升級時間限制。不過，在所有剩餘叢集升級之前，Cassandra 備份和還原功能無法與混合版本搭配使用。舉例來說，Hybrid 1.16 的備份無法用於還原 Hybrid 1.17 執行個體。

  • 升級期間，管理層變更不需完全暫停。如果需要暫時停止管理層變更，我們會在下方的升級操作說明中註明。

升級至 1.17.3 版總覽

升級 Apigee hybrid 的程序分為下列各節：

  1. 準備升級。
  2. 安裝混合式執行階段 1.17.3 版。

準備升級至 1.17 版

備份混合式安裝

  1. 這些操作說明會使用環境變數 APIGEE_HELM_CHARTS_HOME，代表檔案系統中安裝 Helm 圖表的目錄。如有需要，請切換至這個目錄，並使用下列指令定義變數：

    Linux 

    export APIGEE_HELM_CHARTS_HOME=$PWD
echo $APIGEE_HELM_CHARTS_HOME

    Mac OS 

    export APIGEE_HELM_CHARTS_HOME=$PWD
echo $APIGEE_HELM_CHARTS_HOME

    Windows 

    set APIGEE_HELM_CHARTS_HOME=%CD%
echo %APIGEE_HELM_CHARTS_HOME%
  2. 備份 1.16 版 $APIGEE_HELM_CHARTS_HOME/ 目錄。您可以使用任何備份程序。舉例來說，您可以使用下列指令，為整個目錄建立 tar 檔案：
    tar -czvf $APIGEE_HELM_CHARTS_HOME/../apigee-helm-charts-v1.16-backup.tar.gz $APIGEE_HELM_CHARTS_HOME
  3. 按照「Cassandra 備份與復原」中的操作說明，備份 Cassandra 資料庫。
  4. 確認 TLS 憑證和金鑰檔案 (.crt、.key 和/或 .pem) 位於 $APIGEE_HELM_CHARTS_HOME/apigee-virtualhost/ 目錄中。

升級 Kubernetes 版本

檢查 Kubernetes 平台版本，並視需要將 Kubernetes 平台升級至混合式 1.16 和混合式 1.17 均支援的版本。如需協助，請參閱平台的說明文件。

提取 Apigee Helm 圖表。

Apigee hybrid 圖表託管於 Google Artifact Registry：

oci://us-docker.pkg.dev/apigee-release/apigee-hybrid-helm-charts

使用 pull 指令，將所有 Apigee hybrid Helm 圖表複製到本機儲存空間，指令如下：

export CHART_REPO=oci://us-docker.pkg.dev/apigee-release/apigee-hybrid-helm-charts
export CHART_VERSION=1.17.3
helm pull $CHART_REPO/apigee-operator --version $CHART_VERSION --untar
helm pull $CHART_REPO/apigee-datastore --version $CHART_VERSION --untar
helm pull $CHART_REPO/apigee-env --version $CHART_VERSION --untar
helm pull $CHART_REPO/apigee-ingress-manager --version $CHART_VERSION --untar
helm pull $CHART_REPO/apigee-org --version $CHART_VERSION --untar
helm pull $CHART_REPO/apigee-redis --version $CHART_VERSION --untar
helm pull $CHART_REPO/apigee-telemetry --version $CHART_VERSION --untar
helm pull $CHART_REPO/apigee-virtualhost --version $CHART_VERSION --untar

編輯自訂 Apigee 命名空間的 kustomization.yaml

如果 Apigee 命名空間不是 apigee，請編輯 apigee-operator/etc/crds/default/kustomization.yaml 檔案，並將 namespace 值替換為 Apigee 命名空間。

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

namespace: APIGEE_NAMESPACE

如果您使用 apigee 做為命名空間，則不需要編輯檔案。

  • 安裝更新後的 Apigee CRD：

    1. 執行下列指令，使用 kubectl 模擬測試功能：

      kubectl apply -k  apigee-operator/etc/crds/default/ --server-side --force-conflicts --validate=false --dry-run=server

    2. 使用 dry-run 指令驗證後，請執行下列指令：

      kubectl apply -k  apigee-operator/etc/crds/default/ \
  --server-side \
  --force-conflicts \
  --validate=false
    3. 使用 kubectl get crds 指令驗證安裝：
      kubectl get crds | grep apigee

      輸出內容應大致如下：

      apigeedatastores.apigee.cloud.google.com                    2024-08-21T14:48:30Z
apigeedeployments.apigee.cloud.google.com                   2024-08-21T14:48:30Z
apigeeenvironments.apigee.cloud.google.com                  2024-08-21T14:48:31Z
apigeeissues.apigee.cloud.google.com                        2024-08-21T14:48:31Z
apigeeorganizations.apigee.cloud.google.com                 2024-08-21T14:48:32Z
apigeeredis.apigee.cloud.google.com                         2024-08-21T14:48:33Z
apigeerouteconfigs.apigee.cloud.google.com                  2024-08-21T14:48:33Z
apigeeroutes.apigee.cloud.google.com                        2024-08-21T14:48:33Z
apigeetelemetries.apigee.cloud.google.com                   2024-08-21T14:48:34Z
cassandradatareplications.apigee.cloud.google.com           2024-08-21T14:48:35Z

  • 檢查叢集節點上的標籤。根據預設，Apigee 會在標籤為 cloud.google.com/gke-nodepool=apigee-data 的節點上排定資料 Pod，並在標籤為 cloud.google.com/gke-nodepool=apigee-runtime 的節點上排定執行階段 Pod。您可以在 overrides.yaml 檔案中自訂節點集區標籤。

    詳情請參閱「設定專用節點集區」。

    • 升級 cert-manager

    Apigee hybrid 1.17 版支援 cert-manager 1.16 至 1.19 版。cert-manager 1.18 有所異動，可能會導致流量問題。在 cert-manager 1.18 版中，Certificate.Spec.PrivateKey.rotationPolicy 的預設值已從 Never 變更為 Always。如果 Apigee hybrid 安裝項目已升級，這可能會導致流量問題。從舊版升級至 Hybrid 1.17 版時，您必須編輯 apigee-ca 憑證來因應這項異動，或將 cert-manager 版本維持在 1.17.x 版或更低版本。

    將 cert-manager 升級至 1.18 或 1.19 版前，請按照下列步驟編輯 apigee-ca 憑證，將 Certificate.Spec.PrivateKey.rotationPolicy 的值設為 Never。

    1. 檢查 apigee-ca 憑證的內容，確認是否已設定 rotationPolicy： 
      kubectl get certificate apigee-ca -n cert-manager -o yaml

      在輸出內容中，找出 spec.privateKey 下方的值：

      ...
spec:
  commonName: apigee-hybrid
  duration: 87600h
  isCA: true
  issuerRef:
    group: cert-manager.io
    kind: ClusterIssuer
    name: apigee-root-certificate-issuer
  privateKey:
    algorithm: ECDSA
    # Note: rotationPolicy would appear here if it is set.
    size: 256
  secretName: apigee-ca
...
    2. 如果未設定 rotationPolicy，或設為 Always，請編輯 apigee-ca 憑證，將 rotationPolicy 的值設為 Never：
      1. 先執行模擬測試： 
        kubectl patch Certificate \
  --dry-run=server \
  -n cert-manager \
  --type=json \
  -p='[{"op": "replace", "path": "/spec/privateKey/rotationPolicy", "value": "Never"}]' \
  -o=yaml \
  apigee-ca
      2. 修補憑證： 
        kubectl patch Certificate \
  -n cert-manager \
  --type=json \
  -p='[{"op": "replace", "path": "/spec/privateKey/rotationPolicy", "value": "Never"}]' \
  -o=yaml \
  apigee-ca
    3. 確認 rotationPolicy 的值已設為 Never： 
      kubectl get certificate apigee-ca -n cert-manager -o yaml

      輸出內容大致如下：

      ...
spec:
  commonName: apigee-hybrid
  duration: 87600h
  isCA: true
  issuerRef:
    group: cert-manager.io
    kind: ClusterIssuer
    name: apigee-root-certificate-issuer
  privateKey:
    algorithm: ECDSA
    rotationPolicy: Never
    size: 256
  secretName: apigee-ca
...
    4. 升級 cert-manager。下列指令會下載並安裝 cert-manager 1.19.2 版： 
      kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.19.2/cert-manager.yaml

      如需支援的版本清單，請參閱「支援的平台和版本：cert-manager」。

    請參閱：

    安裝 Hybrid 1.17.3 執行階段

    1. 如果尚未前往，請前往 APIGEE_HELM_CHARTS_HOME 目錄。從該目錄執行下列指令。

    2. 模擬測試：

      helm upgrade operator apigee-operator/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE \
  --dry-run=server

      升級圖表：

      helm upgrade operator apigee-operator/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE

      驗證 Apigee Operator 安裝作業：

      helm ls -n APIGEE_NAMESPACE

      NAME       NAMESPACE       REVISION   UPDATED                                STATUS     CHART                   APP VERSION
operator   apigee   3          2024-08-21 00:42:44.492009 -0800 PST   deployed   apigee-operator-1.17.3   1.17.3

      檢查可用性，確認伺服器是否正常運作：

      kubectl -n APIGEE_NAMESPACE get deploy apigee-controller-manager

      NAME                        READY   UP-TO-DATE   AVAILABLE   AGE
apigee-controller-manager   1/1     1            1           7d20h
    3. 升級 Apigee 資料儲存庫：

      模擬測試：

      helm upgrade datastore apigee-datastore/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE \
  --dry-run=server

      升級圖表：

      helm upgrade datastore apigee-datastore/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE

      檢查 apigeedatastore 的狀態，確認是否已啟動並運作：

      kubectl -n APIGEE_NAMESPACE get apigeedatastore default

      NAME      STATE       AGE
default   running    2d
    4. 升級 Apigee 遙測：

      模擬測試：

      helm upgrade telemetry apigee-telemetry/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE \
  --dry-run=server

      升級圖表：

      helm upgrade telemetry apigee-telemetry/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE

      檢查狀態，確認是否已啟動並運作：

      kubectl -n APIGEE_NAMESPACE get apigeetelemetry apigee-telemetry

      NAME               STATE     AGE
apigee-telemetry   running   2d
    5. 升級 Apigee Redis：

      模擬測試：

      helm upgrade redis apigee-redis/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE \
  --dry-run=server

      升級圖表：

      helm upgrade redis apigee-redis/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE

      檢查狀態，確認是否已啟動並運作：

      kubectl -n APIGEE_NAMESPACE get apigeeredis default

      NAME      STATE     AGE
default   running   2d
    6. 升級 Apigee 輸入管理員：

      模擬測試：

      helm upgrade ingress-manager apigee-ingress-manager/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE \
  --dry-run=server

      升級圖表：

      helm upgrade ingress-manager apigee-ingress-manager/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE

      檢查可用性，確認伺服器是否正常運作：

      kubectl -n APIGEE_NAMESPACE get deployment apigee-ingressgateway-manager

      NAME                            READY   UP-TO-DATE   AVAILABLE   AGE
apigee-ingressgateway-manager   2/2     2            2           2d
    7. 升級 Apigee 組織：

      模擬測試：

      helm upgrade ORG_NAME apigee-org/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE \
  --dry-run=server

      升級圖表：

      helm upgrade ORG_NAME apigee-org/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  -f OVERRIDES_FILE

      檢查對應組織的狀態，確認其已啟動並運作中：

      kubectl -n APIGEE_NAMESPACE get apigeeorg

      NAME                      STATE     AGE
apigee-my-org-my-env      running   2d
    8. 升級環境。

      一次只能安裝一個環境。使用 --set env=ENV_NAME 指定環境。

      模擬測試：

      helm upgrade ENV_RELEASE_NAME apigee-env/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --set env=ENV_NAME \
  -f OVERRIDES_FILE \
  --dry-run=server
      • ENV_RELEASE_NAME 是用來追蹤 apigee-env 圖表安裝和升級作業的名稱。這個名稱不得與安裝作業中的其他 Helm 版本名稱重複。 通常與 ENV_NAME 相同。不過，如果環境與環境群組同名，則必須為環境和環境群組使用不同的版本名稱，例如 dev-env-release 和 dev-envgroup-release。如要進一步瞭解 Helm 中的版本，請參閱 Helm 說明文件中的「Three big concepts」(三大概念)。
      • ENV_NAME 是要升級的環境名稱。
      • OVERRIDES_FILE 是 1.17.3 版的新覆寫檔案

      升級圖表：

      helm upgrade ENV_RELEASE_NAME apigee-env/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --set env=ENV_NAME \
  -f OVERRIDES_FILE

      檢查各個環境的狀態，確認是否已啟動並運作：

      kubectl -n APIGEE_NAMESPACE get apigeeenv

      NAME                          STATE       AGE   GATEWAYTYPE
apigee-my-org-my-env          running     2d
    9. 升級環境群組 (virtualhosts)。
      1. 您必須一次升級一個環境群組 (虛擬主機)。使用 --set envgroup=ENV_GROUP_NAME 指定環境群組。針對 overrides.yaml 檔案中提及的每個環境群組，重複執行下列指令：

        模擬測試：

        helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --set envgroup=ENV_GROUP_NAME \
  -f OVERRIDES_FILE \
  --dry-run=server

        ENV_GROUP_RELEASE_NAME 是您先前安裝 apigee-virtualhost 圖表時使用的名稱。通常是 ENV_GROUP_NAME。

        升級圖表：

        helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --set envgroup=ENV_GROUP_NAME \
  -f OVERRIDES_FILE
      2. 檢查 ApigeeRoute (AR) 的狀態。

        安裝 virtualhosts 會建立 ApigeeRouteConfig (ARC)，當 Apigee 監控程式從控制層提取環境群組相關詳細資料時，ApigeeRouteConfig (ARC) 會在內部建立 ApigeeRoute (AR)。因此，請確認對應的 AR 狀態為執行中：

        kubectl -n APIGEE_NAMESPACE get arc

        NAME                                STATE   AGE
apigee-org1-dev-egroup                       2d
         
        kubectl -n APIGEE_NAMESPACE get ar

        NAME                                        STATE     AGE
apigee-org1-dev-egroup-123abc               running   2d

    復原至前一個版本

    如要復原至先前的版本，請使用舊版圖表，以反向順序復原升級程序。從 apigee-virtualhost 開始，逐步回到 apigee-operator，然後還原 CRD。

    1. 還原圖表。下列指令假設您使用的是舊版 (v1.16.x) 的圖表。

      1. 為每個環境群組執行下列指令：

        helm upgrade ENV_GROUP_RELEASE_NAME apigee-virtualhost/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  --set envgroup=ENV_GROUP_NAME \
  -f 1.16_OVERRIDES_FILE

      2. 請為每個環境執行下列指令：

        helm upgrade ENV_RELEASE_NAME apigee-env/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  --set env=ENV_NAME \
  -f 1.16_OVERRIDES_FILE

      3. apigee-org：

        helm upgrade ORG_NAME apigee-org/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f 1.16_OVERRIDES_FILE

      4. apigee-ingress-manager：

        helm upgrade ingress-manager apigee-ingress-manager/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f 1.16_OVERRIDES_FILE

      5. apigee-redis：

        helm upgrade redis apigee-redis/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f 1.16_OVERRIDES_FILE

      6. apigee-telemetry：

        helm upgrade telemetry apigee-telemetry/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f 1.16_OVERRIDES_FILE

      7. apigee-datastore：

        helm upgrade datastore apigee-datastore/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f 1.16_OVERRIDES_FILE

      8. apigee-operator：

        helm upgrade operator apigee-operator/ \
  --install \
  --namespace APIGEE_NAMESPACE \
  --atomic \
  -f 1.16_OVERRIDES_FILE
    2. 重新安裝舊版 CRD，還原 CRD。
      kubectl apply -k apigee-operator/etc/crds/default/ \
  --server-side \
  --force-conflicts \
  --validate=false