容器應用程式閘道路徑、標頭和查詢字串路由 - 閘道 API

發行項
05/09/2024

本文件可協助您設定範例應用程式，以使用閘道 API 中的資源來示範以 URL 路徑、查詢字串和標頭為基礎的流量路由。其中提供下列作業的步驟：

使用一個 HTTPS 接聽程式建立閘道資源。
建立參考後端服務的 HTTPRoute 資源。
使用 HTTPRouteMatch 來執行根據路徑、標頭和查詢字串路由傳送的 matches。

背景

適用於容器的應用程式閘道會根據 URL 路徑、查詢字串和標頭來啟用流量路由。請查看下列範例案例：

此圖顯示具有容器應用程式閘道的路徑、標頭和查詢字串路由。

必要條件

如果遵循 BYO 部署策略，請確定您已設定了適用於容器的應用程式閘道和 ALB 控制器
如果遵循 ALB 受控部署策略，請確定您已透過 ApplicationLoadBalancer 自訂資源佈建了 ALB 控制器，以及適用於容器的應用程式閘道。
部署範例 HTTP 應用程式在您的叢集上套用下列 deployment.yaml 檔案來建立範例 Web 應用程式，從而示範路徑、查詢和標頭型路由。
```
kubectl apply -f https://trafficcontrollerdocs.blob.core.windows.net/examples/traffic-split-scenario/deployment.yaml
```
此指令會在您的叢集上建立下列物件：
- 名為 test-infra 的命名空間
- 在 test-infra 命名空間中的兩個服務，分別名為 backend-v1 和 backend-v2
- 在 test-infra 命名空間中的兩個部署，分別名為 backend-v1 和 backend-v2

建立閘道：

kubectl apply -f - <<EOF
apiVersion: gateway.networking.k8s.io/v1beta1
kind: Gateway
metadata:
  name: gateway-01
  namespace: test-infra
  annotations:
    alb.networking.azure.io/alb-namespace: alb-test-infra
    alb.networking.azure.io/alb-name: alb-test
spec:
  gatewayClassName: azure-alb-external
  listeners:
  - name: http-listener
    port: 80
    protocol: HTTP
    allowedRoutes:
      namespaces:
        from: Same
EOF

注意

當 ALB 控制器在 ARM 中建立適用於容器的應用程式閘道資源時，ALB 控制器會針對前端資源使用下列命名慣例：fe-<8 個隨機產生的字元>

如果您要變更在 Azure 中建立的前端名稱，請考慮遵循自備部署策略。

設定下列環境變數

RESOURCE_GROUP='<resource group name of the Application Gateway For Containers resource>'
RESOURCE_NAME='alb-test'

RESOURCE_ID=$(az network alb show --resource-group $RESOURCE_GROUP --name $RESOURCE_NAME --query id -o tsv)
FRONTEND_NAME='frontend'

建立閘道

kubectl apply -f - <<EOF
apiVersion: gateway.networking.k8s.io/v1beta1
kind: Gateway
metadata:
  name: gateway-01
  namespace: test-infra
  annotations:
    alb.networking.azure.io/alb-id: $RESOURCE_ID
spec:
  gatewayClassName: azure-alb-external
  listeners:
  - name: http-listener
    port: 80
    protocol: HTTP
    allowedRoutes:
      namespaces:
        from: Same
  addresses:
  - type: alb.networking.azure.io/alb-frontend
    value: $FRONTEND_NAME
EOF

建立閘道資源之後，請確定狀態有效，接聽程式的狀態為已程式化，並且已經將位址指派給閘道。

kubectl get gateway gateway-01 -n test-infra -o yaml

成功建立閘道後輸出內容的範例。

status:
  addresses:
  - type: Hostname
    value: xxxx.yyyy.alb.azure.com
  conditions:
  - lastTransitionTime: "2023-06-19T21:04:55Z"
    message: Valid Gateway
    observedGeneration: 1
    reason: Accepted
    status: "True"
    type: Accepted
  - lastTransitionTime: "2023-06-19T21:04:55Z"
    message: Application Gateway For Containers resource has been successfully updated.
    observedGeneration: 1
    reason: Programmed
    status: "True"
    type: Programmed
  listeners:
  - attachedRoutes: 0
    conditions:
    - lastTransitionTime: "2023-06-19T21:04:55Z"
      message: ""
      observedGeneration: 1
      reason: ResolvedRefs
      status: "True"
      type: ResolvedRefs
    - lastTransitionTime: "2023-06-19T21:04:55Z"
      message: Listener is accepted
      observedGeneration: 1
      reason: Accepted
      status: "True"
      type: Accepted
    - lastTransitionTime: "2023-06-19T21:04:55Z"
      message: Application Gateway For Containers resource has been successfully updated.
      observedGeneration: 1
      reason: Programmed
      status: "True"
      type: Programmed
    name: https-listener
    supportedKinds:
    - group: gateway.networking.k8s.io
      kind: HTTPRoute

建立閘道之後，請建立 HTTPRoute 來定義兩個不同的相符項目，以及流量路由傳送目標的預設服務。

下列規則的讀取方式如下：

如果路徑為 /bar，流量會路由傳送至連接埠 8080 上的 backend-v2 服務，或者
如果要求包含名稱為 magic 且值為 foo 的 HTTP 標頭、URL 包含定義了名稱 great 和值 example 的查詢字串，並且路徑為 /some/thing，則會將要求傳送至連接埠 8080 上的 backend-v2。
否則，所有其他要求都會路由傳送至連接埠 8080 上的 backend-v1 服務。

kubectl apply -f - <<EOF
apiVersion: gateway.networking.k8s.io/v1beta1
kind: HTTPRoute
metadata:
  name: http-route
  namespace: test-infra
spec:
  parentRefs:
  - name: gateway-01
    namespace: test-infra
  rules:
  - matches:
    - path:
        type: PathPrefix
        value: /bar
    backendRefs:
    - name: backend-v2
      port: 8080
  - matches:
    - headers:
      - type: Exact
        name: magic
        value: foo
      queryParams:
      - type: Exact
        name: great
        value: example
      path:
        type: PathPrefix
        value: /some/thing
      method: GET
    backendRefs:
    - name: backend-v2
      port: 8080
  - backendRefs:
    - name: backend-v1
      port: 8080
EOF

建立 HTTPRoute 資源之後，請確定路由的狀態為「已接受」，且適用於容器的應用程式閘道資源的狀態為「已程式化」。

kubectl get httproute http-route -n test-infra -o yaml

確認已成功更新適用於容器的應用程式閘道資源的狀態。

status:
  parents:
  - conditions:
    - lastTransitionTime: "2023-06-19T22:18:23Z"
      message: ""
      observedGeneration: 1
      reason: ResolvedRefs
      status: "True"
      type: ResolvedRefs
    - lastTransitionTime: "2023-06-19T22:18:23Z"
      message: Route is Accepted
      observedGeneration: 1
      reason: Accepted
      status: "True"
      type: Accepted
    - lastTransitionTime: "2023-06-19T22:18:23Z"
      message: Application Gateway For Containers resource has been successfully updated.
      observedGeneration: 1
      reason: Programmed
      status: "True"
      type: Programmed
    controllerName: alb.networking.azure.io/alb-controller
    parentRef:
      group: gateway.networking.k8s.io
      kind: Gateway
      name: gateway-01
      namespace: test-infra

測試應用程式的存取權

現在我們已準備好將一些流量透過指派給前端的 FQDN 傳送至範例應用程式。使用下列命令來取得 FQDN。

fqdn=$(kubectl get gateway gateway-01 -n test-infra -o jsonpath='{.status.addresses[0].value}')

透過使用 curl 命令，我們可以驗證三種不同的案例：

路徑型路由

在此案例中，傳送至 http://frontend-fqdn/bar 的用戶端要求會路由傳送至 backend-v2 服務。

執行以下命令：

curl http://$fqdn/bar

請注意，為要求提供服務的容器是 backend-v2。

在此案例中，傳送至 http://frontend-fqdn/some/thing?great=example 且標頭索引鍵/值部分為 "magic: foo" 的用戶端要求會路由傳送至 backend-v2 服務。

執行以下命令：

curl http://$fqdn/some/thing?great=example -H "magic: foo"

請注意，為要求提供服務的容器是 backend-v2。

預設路由

如果前兩個案例都未滿足，適用於容器的應用程式閘道會將所有其他要求路由傳送至 backend-v1 服務。

執行以下命令：

curl http://$fqdn/

請注意，為要求提供服務的容器是 backend-v1。

恭喜您，您已安裝了 ALB 控制器、部署了後端應用程式，並且在適用於容器的應用程式閘道上透過閘道 API 將流量路由傳送至應用程式。

Share via

容器應用程式閘道路徑、標頭和查詢字串路由 - 閘道 API

背景

必要條件

部署必要的閘道 API 資源

測試應用程式的存取權

路徑型路由

查詢字串 + 標頭 + 路徑路由

預設路由

其他資源

Share via

容器 應用程式閘道 路徑、標頭和查詢字串路由 - 閘道 API

背景

必要條件

部署必要的閘道 API 資源

測試應用程式的存取權

路徑型路由

查詢字串 + 標頭 + 路徑路由

預設路由

其他資源

容器應用程式閘道路徑、標頭和查詢字串路由 - 閘道 API