Container Service for Kubernetes：通過控制台或Annotations自訂ALB Ingress的轉寄規則

轉寄條件

描述

網域名稱

匹配請求網域名稱，只有正確的網域名稱的請求才能訪問服務。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
      "type": "Host",
      "hostConfig": {
        "values": [
          "anno.example.com"
        ]
      }
  }]

• type：匹配類型。設定為Host，表示匹配網域名稱。

• HostConfig：匹配的具體網域名稱。如果設定了多個網域名稱，則網域名稱之間是或的關係。

路徑

匹配請求路徑，只有正確的路徑的請求才能訪問服務。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
    "type": "Path",
    "pathConfig": {
      "values": [
        "/pathvalue1",
        "/pathvalue2"
      ]
    }
  }]

• type：匹配類型。設定為Path，表示匹配請求路徑。

• pathConfig：匹配的具體路徑。如果設定了多個路徑，則路徑之間是或的關係。

Header

匹配請求Header，只有正確的Header的請求才能訪問服務。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
    "type": "Header",
    "headerConfig": {
      "key": "headername",
      "values": [
        "headervalue1",
        "headervalue2"
      ]
     }
  }]

• type：匹配類型。設定為Header，表示匹配要求標頭中的Header。

• headerConfig：Header的索引值對。如果設定了多個Header值，則Header之間是或的關係。

查詢字串

匹配查詢字串， 只有包含正確的查詢字串的請求才能訪問服務。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
    "type": "QueryString",
    "queryStringConfig": {
      "values": [
        {
           "key":"querystringkey1",
           "value":"querystringvalue2"
        }
      ]
    }
  }]

• type：匹配類型。設定為QueryString，表示匹配請求的查詢字串。

• queryStringConfig：查詢字串的索引值對。鍵字元長度取值為[1,100]，值字元長度取值為[1,100]，支援小寫字母、可見字元和萬用字元星號（*）和英文半形問號（?），不支援空格和#[]{}\|<>&。如果設定了多個查詢字串，則查詢字串之間是或的關係。

使用情境與樣本請參見情境三：基於查詢字串、多個Header、多個路徑實現流量分發。

要求方法

匹配要求方法，只有正確的要求方法的請求才能訪問服務。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
    "type": "Method",
    "methodConfig": {
      "values": [
        "GET",
        "HEAD"
      ]
    }
  }]

• type：匹配類型。設定為Method，表示匹配要求方法。

• methodConfig：具體的要求方法，支援GET、POST、PUT、DELETE、HEAD、OPTIONS和PATCH。如果設定了多個要求方法，則要求方法之間是或的關係。

Cookie

匹配Cookie，只有包含正確的Cookie的請求才能訪問服務。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
    "type": "Cookie",
    "cookieConfig": {
      "values": [
        {
           "key":"cookiekey1",
           "value":"cookievalue2"
        }
      ]
     }
  }]

• type：匹配類型。設定為Cookie，表示匹配Cookie。

• cookieConfig：Cookie的索引值對。鍵字元長度取值為[1,100]，值字元長度取值為[1,100]，支援小寫字母、可見字元和萬用字元星號（*）和英文半形問號（?），不支援空格和#[]{}\|<>&。如果設定了多個Cookie，則Cookie之間是或的關係。

使用情境與樣本請參見情境二：基於網域名稱、要求方法、Cookie實現流量分發。

SourceIP

匹配請求源IP，只有正確的源IP的請求才能訪問服務。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
    "type": "SourceIp",
    "sourceIpConfig": {
      "values": [
        "192.168.0.0/16",
        "172.16.0.0/16"
      ]
    }
  }]

• type：匹配類型。設定為SourceIP，表示匹配請求的源IP。

• sourceIpConfig：請求的IP地址。如果設定了多個請求IP，則請求IP之間是或的關係。

使用情境與樣本請參見情境一：基於SourceIP和Header實現流量分發。

ResponseHeader

匹配響應Header，只對攜帶正確的Header的響應執行轉寄動作。請注意與回應程式向轉寄動作及回應程式向轉寄規則註解alb.ingress.kubernetes.io/rule-direction.<service-name>: Response配合使用。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
    "type": "ResponseHeader",
    "headerConfig": {
      "key": "responseHeaderConfig",
      "values": [
        "headervalue1",
        "headervalue2"
      ]
     }
  }]

• type：匹配類型。設定為ResponseHeader，表示匹配回應標頭中的Header。

• headerConfig：Header的索引值對。如果設定了多個Header值，則Header之間是或的關係。

ResponseStatusCode

匹配響應狀態代碼，只有返回正確的狀態代碼才能訪問服務。請注意與回應程式向轉寄動作及回應程式向轉寄規則註解alb.ingress.kubernetes.io/rule-direction.<service-name>: Response配合使用。樣本如下。

alb.ingress.kubernetes.io/conditions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄條件將生效至相應後端服務。
  [{
    "type": "ResponseStatusCode",
    "responseStatusCodeConfig": {
      "values": [
        "statuscode1",
        "statuscode2"
      ]
    }
  }]

• type：匹配類型。設定為ResponseStatusCode，表示匹配響應狀態代碼。

• responseStatusCodeConfig：具體的響應狀態代碼。如果設定了多個響應狀態代碼，則響應狀態代碼之間是或的關係。

轉寄動作

描述

固定響應

設定通過ALB給用戶端返回固定響應內容，可以設定響應狀態代碼，本文內容和本文類型。樣本如下。

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
  [{
      "type": "FixedResponse",
      "FixedResponseConfig": {
          "contentType": "text/plain",
          "httpCode": "503",
          "content": "503 error text"
      }
  }]

• type：轉寄動作類型，設定為FixedResponse，表示配置固定響應。

• contentType：響應本文類型。

• httpCode：響應狀態代碼。

• content：響應本文。

固定響應的情境樣本，請參見情境一：基於網域名稱的轉寄條件和動作，轉寄至指定的服務。

重新導向

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
  [{
      "type": "Redirect",
      "RedirectConfig": {
          "host": "${host}",
          "path": "/test",
          "port": "443",
          "protocol": "https",
          "query": "querystring",
          "httpCode": "301"
      }
  }]

• type：轉寄動作類型，設定為Redirect，表示配置重新導向。

• host：跳轉的網域名稱。

• path：跳轉的路徑。

• port：跳轉的連接埠。

• protocol：跳轉的協議。

• query：跳轉的查詢字串。

• httpCode：跳轉後的狀態代碼。

重新導向的情境樣本，請參見情境二：使用301重新導向到HTTPS連接埠

流量鏡像

設定流量鏡像轉寄伺服器組ID，將複製請求轉寄至流量鏡像伺服器組。樣本如下。

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
      [{
          "type": "TrafficMirror",
          "TrafficMirrorConfig": {
              "TargetType" : "ForwardGroupMirror",
              "MirrorGroupConfig": {
                  "ServerGroupTuples" : [{
                      "ServerGroupID": "sgp-2auud2fxj1r46*****"
                  }]
              }
           }
      }]

• type：轉寄動作類型，設定為TrafficMirror，表示配置流量鏡像功能。

• TargetType：鏡像的目標類型，當前只支援ForwardGroupMirror類型，即鏡像請求至伺服器組。

• ServerGroupID：流量鏡像伺服器組ID。

流量鏡像的情境樣本，請參見情境四：流量鏡像至伺服器組。

轉寄至後端多伺服器組

設定將ALB請求轉寄至後端多個伺服器組，可以通過ServerGroupID指定後端掛載的伺服器組，也可以通過ServiceName+ServicePort建立或掛載伺服器組。可以佈建要求轉寄至各後端伺服器組的權重，也支援開啟伺服器組間會話保持。

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
       [{
           "type": "ForwardGroup",
           "ForwardConfig": {
             "ServerGroups" : [{
               "ServiceName": "tea-svc",
               "Weight": 30,
               "ServicePort": 80
             },
             {
               "ServiceName": "coffee-svc",
               "Weight": 20,
               "ServicePort": 80
             },
             {
               "ServerGroupID": "sgp-71aexb9y93ypo*****",
               "Weight": 20
             },
             {
               "ServerGroupID": "sgp-slygpbvm2cydo*****",
               "Weight": 30
             }],
             "ServerGroupStickySession": {
              "Enabled": true,
              "Timeout": 80
             }
           }
       }]

• type：轉寄動作類型，設定為ForwardGroup，表示配置轉寄至後端多伺服器組。

• ForwardConfig：後端轉寄伺服器組具體參數。如果設定了多個伺服器組，請求按照權重轉寄至各伺服器組。

• ServerGroupID：伺服器組ID。

• ServiceName：服務的名稱。

• ServicePort：服務的連接埠。

• Weight：請求轉寄至各伺服器組權重。

• Enabled：是否開啟伺服器組間會話保持。

• Timeout：伺服器組間會話保持逾時時間。

轉寄至多伺服器組的情境樣本，請參見情境五：請求轉寄至多個後端伺服器組。

重寫

設定ALB支援重寫，在接到用戶端請求後，可以修改請求的網域名稱、路徑和查詢字串再轉寄到後端。

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
       [{
           "type": "Rewrite",
           "RewriteConfig": {
               "Host": "demo.domain.ingress.top",
               "Path": "/test",
               "Query": "querystring"
           }
       }]

• type：轉寄動作類型，設定為Rewrite使用重寫。

• host：重寫後請求使用的網域名稱，設定為${host}、不填寫值（"host": ""）、或不配置此項時，表明使用原請求中的值。

• path：重寫後請求使用的路徑，設定為${path}、不填寫值（"path": ""）、或不配置此項時，表明使用原請求中的值。

• query：重寫後請求的查詢字串，設定為${query}、不填寫值（"query": ""）、或不配置此項時，表明使用原請求中的值。

重寫的情境樣本，請參見情境六：重寫請求配置資訊。

插入要求標頭

設定頭欄位名稱和頭欄位內容，將覆蓋請求中已有的頭變數。樣本如下。

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
  [{
      "type": "InsertHeader",
      "InsertHeaderConfig": {
          "key": "key",
          "value": "value",
          "valueType": "UserDefined"
      }
  }]

• type：轉寄動作類型，設定為InsertHeader，表示配置插入要求標頭。

• key：要求標頭的欄位名稱。

• value：要求標頭的欄位內容。

• valueType：實值型別。

插入要求標頭的情境樣本，請參見情境三：插入source: alibaba要求標頭。

刪除要求標頭

刪除頭欄位名稱和頭欄位內容。樣本如下。

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
     [{
         "type": "RemoveHeader",
         "RemoveHeaderConfig": {
             "key": "key"
         }
     }]

type：轉寄動作類型，設定為RemoveHeader，表示配置刪除要求標頭。

key：要求標頭的欄位名稱。

QPS限速

設定ALB的轉寄規則時，可以同時配置總體請求速率限制和基於用戶端源IP的請求速率限制。

具體配置樣本如下：

 annotations:
    alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
      [{
          "type": "TrafficLimit",
          "TrafficLimitConfig": {
              "QPS": "1000",
              "QPSPerIp": "100"
          }
      }]

• type：指定轉寄動作的類型，此處設定為TrafficLimit，表示這是一個限速配置。

• QPS：總體請求速率限制，即每秒可以處理的請求次數，取值範圍是[1,1000000]。當請求速率超出設定的規格後，超出部分的建立串連請求將被拒絕，並且用戶端將收到HTTP狀態代碼503。

• QPSPerIp：表示基於每個用戶端源IP的請求速率限制，取值範圍是[1,1000000]。當同時設定了QPS（總體限速）和QPSPerIp（基於用戶端源IP的限速）時，後者的值必須小於前者。當請求速率超出了設定的規格後，超出部分的請求將被拒絕，並且用戶端將收到HTTP狀態代碼503。

轉寄動作

描述

插入要求標頭

設定頭欄位名稱和頭欄位內容，將覆蓋請求中已有的頭變數。樣本如下。

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
  [{
      "type": "InsertHeader",
      "InsertHeaderConfig": {
          "key": "key",
          "value": "value",
          "valueType": "UserDefined"
      }
  }]

• type：轉寄動作類型，設定為InsertHeader，表示配置插入要求標頭。

• key：要求標頭的欄位名稱。

• value：要求標頭的欄位內容。

• valueType：實值型別。

在回應程式向修改要求標頭的情境樣本，請參見情境七：基於ResponseHeader對回應程式向的要求標頭進行修改、情境八：基於響應狀態代碼對回應程式向的要求標頭進行修改。

刪除要求標頭

刪除頭欄位名稱和頭欄位內容。樣本如下。

alb.ingress.kubernetes.io/actions.service-name: | # 請注意：此註解名稱中的"service-name"必須與spec.rules中配置的後端服務名稱對應一致，註解中所配置的轉寄動作將對應生效。
     [{
         "type": "RemoveHeader",
         "RemoveHeaderConfig": {
             "key": "key"
         }
     }]

type：轉寄動作類型，設定為RemoveHeader，表示配置刪除要求標頭。

key：要求標頭的欄位名稱。