Tüm Ürünler
Search
Belge Merkezi

API Gateway:Advanced APIG Ingress usage

Son Güncelleme:Oct 16, 2026

APIG Ingress, Katman 7 yük dengeleme ile küme hizmetlerine yönelik dış erişimi yönetir. Gelişmiş trafik yönlendirmeyi, hız sınırlamayı ve güvenlik özelliklerini yapılandırmak için Ingress kaynaklarınıza ek açıklamalar ekleyin.

Bu konudaki örneklerde hem nginx.ingress.kubernetes.io hem de higress.ingress.kubernetes.io ek açıklama ön ekleri kullanılır. Her ek açıklamanın geçerli olduğu ön ek aşağıdaki ek açıklama dizininde gösterilmiştir.

Ek açıklama dizini

Açıklamasına gitmek için bir ek açıklama adına tıklayın.

Ek Açıklama Tür Kapsam Özellik
nginx.ingress.kubernetes.io/canary string ("true") Route Canary sürümü
nginx.ingress.kubernetes.io/canary-by-header string Route Başlık tabanlı canary sürümü
nginx.ingress.kubernetes.io/canary-by-header-value string Route Başlık tabanlı canary sürümü
higress.ingress.kubernetes.io/canary-by-query string Route Sorgu parametresi tabanlı canary sürümü
higress.ingress.kubernetes.io/canary-by-query-value string Route Sorgu parametresi tabanlı canary sürümü
nginx.ingress.kubernetes.io/canary-by-cookie string Route Çerez tabanlı canary sürümü
nginx.ingress.kubernetes.io/canary-weight integer (0–100) Route Ağırlık tabanlı canary sürümü
nginx.ingress.kubernetes.io/canary-weight-total integer Route Ağırlık tabanlı canary sürümü
higress.ingress.kubernetes.io/service-subset string Route Hizmet alt kümesi
higress.ingress.kubernetes.io/subset-labels string Route Özel etiketlerle hizmet alt kümesi
nginx.ingress.kubernetes.io/enable-cors boolean Route CORS
nginx.ingress.kubernetes.io/cors-allow-origin string Route CORS
nginx.ingress.kubernetes.io/cors-allow-methods string Route CORS
nginx.ingress.kubernetes.io/cors-allow-headers string Route CORS
nginx.ingress.kubernetes.io/cors-expose-headers string Route CORS
nginx.ingress.kubernetes.io/cors-allow-credentials boolean Route CORS
nginx.ingress.kubernetes.io/cors-max-age integer (seconds) Route CORS
nginx.ingress.kubernetes.io/use-regex boolean Route Düzenli ifade eşleşmesi
nginx.ingress.kubernetes.io/rewrite-target string Route Yol yeniden yazma
nginx.ingress.kubernetes.io/upstream-vhost string Domain Ana bilgisayar adı yeniden yazma
nginx.ingress.kubernetes.io/ssl-redirect boolean Route HTTP'den HTTPS'ye yönlendirme
nginx.ingress.kubernetes.io/force-ssl-redirect boolean Route HTTP'den HTTPS'ye yönlendirme
nginx.ingress.kubernetes.io/permanent-redirect URL Route Kalıcı yönlendirme
nginx.ingress.kubernetes.io/permanent-redirect-code integer Route Kalıcı yönlendirme
nginx.ingress.kubernetes.io/temporal-redirect URL Route Geçici yönlendirme
higress.ingress.kubernetes.io/request-header-control-add string Route İstek başlığı kontrolü
higress.ingress.kubernetes.io/request-header-control-update string Route İstek başlığı kontrolü
higress.ingress.kubernetes.io/request-header-control-remove string Route İstek başlığı kontrolü
higress.ingress.kubernetes.io/response-header-control-add string Route Yanıt başlığı kontrolü
higress.ingress.kubernetes.io/response-header-control-update string Route Yanıt başlığı kontrolü
higress.ingress.kubernetes.io/response-header-control-remove string Route Yanıt başlığı kontrolü
nginx.ingress.kubernetes.io/proxy-next-upstream-tries integer Route Yeniden deneme
nginx.ingress.kubernetes.io/proxy-next-upstream-timeout integer (seconds) Route Yeniden deneme
nginx.ingress.kubernetes.io/proxy-next-upstream string Route Yeniden deneme
nginx.ingress.kubernetes.io/whitelist-source-range CIDR/IP Route IP erişim kontrolü
higress.ingress.kubernetes.io/blacklist-source-range CIDR/IP Route IP erişim kontrolü
higress.ingress.kubernetes.io/domain-whitelist-source-range CIDR/IP Domain IP erişim kontrolü
higress.ingress.kubernetes.io/domain-blacklist-source-range CIDR/IP Domain IP erişim kontrolü
higress.ingress.kubernetes.io/route-limit-rpm integer Route Tek ağ geçidi kısıtlaması
higress.ingress.kubernetes.io/route-limit-rps integer Route Tek ağ geçidi kısıtlaması
higress.ingress.kubernetes.io/route-limit-burst-multiplier integer Route Tek ağ geçidi kısıtlaması
higress.ingress.kubernetes.io/rate-limit integer (RPS) Route Genel kısıtlama kontrolü
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-code integer Route Genel kısıtlama kontrolü
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body-type string Route Genel kısıtlama kontrolü
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body string Route Genel kısıtlama kontrolü
higress.ingress.kubernetes.io/rate-limit-fallback-redirect-url URL Route Genel kısıtlama kontrolü
higress.ingress.kubernetes.io/concurrency-limit integer Route Genel eşzamanlılık kontrolü
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-code integer Route Genel eşzamanlılık kontrolü
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body-type string Route Genel eşzamanlılık kontrolü
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body string Route Genel eşzamanlılık kontrolü
higress.ingress.kubernetes.io/concurrency-limit-fallback-redirect-url URL Route Genel eşzamanlılık kontrolü
higress.ingress.kubernetes.io/mirror-target-service string (namespace/name:port) Route Trafik yansıtma
higress.ingress.kubernetes.io/mirror-percentage integer (0–100) Route Trafik yansıtma
nginx.ingress.kubernetes.io/backend-protocol string (HTTPS, GRPC) Route Arka uç hizmet protokolleri
nginx.ingress.kubernetes.io/load-balance string Route Yük dengeleme algoritmaları
nginx.ingress.kubernetes.io/upstream-hash-by string Route Tutarlı karma
higress.ingress.kubernetes.io/warmup integer (seconds) Route Isınma (yumuşak başlatma)
nginx.ingress.kubernetes.io/affinity string ("cookie") Route Çerez bağlılığı
nginx.ingress.kubernetes.io/affinity-mode string ("balanced" veya "persistent") Route Çerez bağlılığı
nginx.ingress.kubernetes.io/session-cookie-name string Route Çerez bağlılığı
nginx.ingress.kubernetes.io/session-cookie-path string Route Çerez bağlılığı
nginx.ingress.kubernetes.io/session-cookie-max-age integer (seconds) Route Çerez bağlılığı
nginx.ingress.kubernetes.io/session-cookie-expires integer (seconds) Route Çerez bağlılığı
higress.ingress.kubernetes.io/connection-policy-tcp-max-connection integer Route Bağlantı havuzu
higress.ingress.kubernetes.io/connection-policy-tcp-max-connection-per-endpoint integer Route Bağlantı havuzu
higress.ingress.kubernetes.io/connection-policy-http-max-request-per-connection integer Route Bağlantı havuzu
higress.ingress.kubernetes.io/tls-min-protocol-version string Domain TLS sürümleri ve şifre paketleri
higress.ingress.kubernetes.io/tls-max-protocol-version string Domain TLS sürümleri ve şifre paketleri
nginx.ingress.kubernetes.io/ssl-cipher string Domain TLS sürümleri ve şifre paketleri
nginx.ingress.kubernetes.io/proxy-ssl-secret string (namespace/name) Route Arka uç hizmetleriyle mTLS
nginx.ingress.kubernetes.io/proxy-ssl-name string Route Arka uç hizmetleriyle mTLS
nginx.ingress.kubernetes.io/proxy-ssl-server-name boolean Route Arka uç hizmetleriyle mTLS

Canary sürümü

Canary sürümleri, mevcut üretim sürümünü devre dışı bırakmadan trafiği yeni bir hizmet sürümüne kaydırmanıza olanak tanır. Özelliği nginx.ingress.kubernetes.io/canary: "true" ile etkinleştirin, ardından trafiğin nasıl dağıtılacağını kontrol etmek için bir veya daha fazla hedefleme ek açıklaması ekleyin.

Aynı Ingress üzerinde birden çok hedefleme yöntemi yapılandırıldığında kurallar şu öncelik sırasına göre değerlendirilir:

Çerez > Başlık > Sorgu parametresi > Ağırlık

Başlık tabanlı canary sürümü

Ek Açıklama Açıklama
nginx.ingress.kubernetes.io/canary-by-header Trafiği bir istek başlığı adına göre yönlendirir. Trafiği her zaman canary'e yönlendirmek için başlık değerini always olarak ayarlayın. Diğer tüm değerler, canary-by-header-value da eşleşmedikçe trafiği üretime yönlendirir.
nginx.ingress.kubernetes.io/canary-by-header-value canary-by-header ile birlikte kullanıldığında, yalnızca başlık adı ve değeri eşleşirse canary hizmetine yönlendirir.

Örnek 1: apig: always başlıklı istekleri canary hizmetine yönlendirin

1.19 ve sonraki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "apig"
  name: demo-canary
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /hello
            pathType: Exact

1.19'dan önceki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "apig"
  name: demo-canary
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: Başlık değerine göre birden çok canary sürümüne yönlendirin (apig: v1 → v1, apig: v2 → v2)

1.19 ve sonraki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "apig"
    nginx.ingress.kubernetes.io/canary-by-header-value: "v1"
  name: demo-canary-v1
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary-v1
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "apig"
    nginx.ingress.kubernetes.io/canary-by-header-value: "v2"
  name: demo-canary-v2
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary-v2
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /hello
            pathType: Exact

1.19'dan önceki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "apig"
    nginx.ingress.kubernetes.io/canary-by-header-value: "v1"
  name: demo-canary-v1
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary-v1
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "apig"
    nginx.ingress.kubernetes.io/canary-by-header-value: "v2"
  name: demo-canary-v2
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary-v2
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service
              servicePort: 80

Sorgu parametresi tabanlı canary sürümü

Ek Açıklama Açıklama
higress.ingress.kubernetes.io/canary-by-query Trafiği bir URL sorgu parametresi adına göre yönlendirir. Canary hizmetine yönlendirmek için parametre değerini always olarak ayarlayın.
higress.ingress.kubernetes.io/canary-by-query-value canary-by-query ile birlikte kullanıldığında, yalnızca sorgu parametresi adı ve değeri eşleşirse canary hizmetine yönlendirir.

Başlık tabanlı ve sorgu parametresi tabanlı kurallar birleştirilebilir. İkisi de yapılandırıldığında, yalnızca her iki koşul da eşleştiğinde istek canary hizmetine yönlendirilir.

Örnek 1: URL sorgu parametresi canary=gray içeren istekleri canary hizmetine yönlendirin

1.19 ve sonraki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    higress.ingress.kubernetes.io/canary-by-query: "canary"
    higress.ingress.kubernetes.io/canary-by-query-value: "gray"
  name: demo-canary
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /hello
            pathType: Exact

1.19'dan önceki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    higress.ingress.kubernetes.io/canary-by-query: "canary"
    higress.ingress.kubernetes.io/canary-by-query-value: "gray"
  name: demo-canary
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: Yalnızca URL'de canary=gray ve başlıkta x-user-id: test bulunduğunda canary'e yönlendirin

1.19 ve sonraki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    higress.ingress.kubernetes.io/canary-by-query: "canary"
    higress.ingress.kubernetes.io/canary-by-query-value: "gray"
    nginx.ingress.kubernetes.io/canary-by-header: "x-user-id"
    nginx.ingress.kubernetes.io/canary-by-header-value: "test"
  name: demo-canary
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /hello
            pathType: Exact

1.19'dan önceki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    higress.ingress.kubernetes.io/canary-by-query: "canary"
    higress.ingress.kubernetes.io/canary-by-query-value: "gray"
    nginx.ingress.kubernetes.io/canary-by-header: "x-user-id"
    nginx.ingress.kubernetes.io/canary-by-header-value: "test"
  name: demo-canary
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service
              servicePort: 80

Çerez tabanlı canary sürümü

Trafiği bir çereze göre bölmek için nginx.ingress.kubernetes.io/canary-by-cookie kullanın. İstekleri canary hizmetine yönlendirmek için çerez değerini always olarak ayarlayın; diğer tüm istekler üretim hizmetine gider.

Çerez tabanlı canary sürümü özel değerleri desteklemez. Çerez değeri always olmalıdır.

Örnek: demo=always çerezli istekleri canary hizmetine yönlendirin

1.19 ve sonraki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-cookie: "demo"
  name: demo-canary
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /hello
            pathType: Exact

1.19'dan önceki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-cookie: "demo"
  name: demo-canary
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service
              servicePort: 80

Ağırlık tabanlı canary sürümü

Ek Açıklama Açıklama Varsayılan
nginx.ingress.kubernetes.io/canary-weight Canary sürümüne yönlendirilen isteklerin yüzdesi. 0 ile 100 arasında tamsayı. —
nginx.ingress.kubernetes.io/canary-weight-total Tüm sürümler arasındaki toplam ağırlık. 100

Örnek: Trafiği üç sürüm arasında bölün — canary v1 %30, canary v2 %20, üretim %50

1.19 ve sonraki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-weight: "30"
  name: demo-canary-v1
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary-v1
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-weight: "20"
  name: demo-canary-v2
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary-v2
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /hello
            pathType: Exact

1.19'dan önceki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-weight: "30"
  name: demo-canary-v1
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary-v1
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-weight: "20"
  name: demo-canary-v2
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary-v2
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service
              servicePort: 80

Hizmet alt kümesi

Hizmet alt kümeleri, trafiği bir Hizmet içindeki belirli Pod'lara yönlendirmenize olanak tanır; bu, bir Hizmetin farklı kod sürümlerini çalıştıran birden çok Dağıtım tarafından desteklendiği durumlarda kullanışlıdır.

APIG Ingress için pod etiketi kuralını kullanın

Hangi Pod grubunun istek alacağını belirtmek için higress.ingress.kubernetes.io/service-subset değerini ayarlayın. Varsayılan olarak APIG Ingress, alt küme değerini opensergo.io/canary ön ekiyle başlayan Pod etiketlerine eşler:

  • Değer "" veya base ise: opensergo.io/canary: "" etiketli Pod'lara veya opensergo.io/canary ön ekli etiketi olmayan Pod'lara yönlendirir.

  • Diğer herhangi bir dize (örneğin gray): opensergo.io/canary-gray: gray etiketli Pod'lara yönlendirir.

Örnek: x-user-id: test isteklerini go-httpbin'in gray Dağıtımına yönlendirin

Önce Hizmeti ve Dağıtımları uygulayın:

# Kubernetes Service
apiVersion: v1
kind: Service
metadata:
  name: go-httpbin
  namespace: default
spec:
  ports:
    - port: 8080
      protocol: TCP
  selector:
    app: go-httpbin
---
# Base Deployment — no opensergo.io/canary label
apiVersion: apps/v1
kind: Deployment
metadata:
  name: go-httpbin-base
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: go-httpbin
  template:
    metadata:
      labels:
        app: go-httpbin
    spec:
      containers:
        - image: registry.cn-hangzhou.aliyuncs.com/apig/go-httpbin
          args:
            - "--version=base"
          imagePullPolicy: Always
          name: go-httpbin
---
# Gray Deployment — has label opensergo.io/canary-gray: gray
apiVersion: apps/v1
kind: Deployment
metadata:
  name: go-httpbin-gray
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: go-httpbin
  template:
    metadata:
      labels:
        app: go-httpbin
        opensergo.io/canary-gray: gray
    spec:
      containers:
        - image: registry.cn-hangzhou.aliyuncs.com/apig/go-httpbin
          args:
            - "--version=gray"
          imagePullPolicy: Always
          name: go-httpbin

Ardından Ingress kaynaklarını yapılandırın:

1.19 ve sonraki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "x-user-id"
    nginx.ingress.kubernetes.io/canary-by-header-value: "test"
    # Forward to Pods with label opensergo.io/canary-gray: gray
    higress.ingress.kubernetes.io/service-subset: gray
  name: demo-canary
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: go-httpbin
                port:
                  number: 8080
            path: /test
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    # Forward to Pods with no opensergo.io/canary-prefixed label
    higress.ingress.kubernetes.io/service-subset: ""
  name: demo
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: go-httpbin
                port:
                  number: 8080
            path: /test
            pathType: Exact

1.19'dan önceki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "x-user-id"
    nginx.ingress.kubernetes.io/canary-by-header-value: "test"
    # Forward to Pods with label opensergo.io/canary-gray: gray
    higress.ingress.kubernetes.io/service-subset: gray
  name: demo-canary
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /test
            backend:
              serviceName: go-httpbin
              servicePort: 8080
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    # Forward to Pods with no opensergo.io/canary-prefixed label
    higress.ingress.kubernetes.io/service-subset: ""
  name: demo
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /test
            backend:
              serviceName: go-httpbin
              servicePort: 8080

Özel etiketleri kullanın

Pod'ları opensergo.io/canary kuralı yerine herhangi bir keyfi etikete göre hedeflemek için hem higress.ingress.kubernetes.io/service-subset hem de higress.ingress.kubernetes.io/subset-labels değerlerini ayarlayın.

subset-labels yapılandırıldığında, alt küme artık opensergo.io/canary ön ekli etiketlere eşlenmez.

Örnek: x-user-id: test isteklerini version: gray etiketli Pod'lara yönlendirin

Önce Dağıtımları uygulayın (version: gray etiketi gray Dağıtımının Pod şablonuna eklenir):

# go-httpbin Kubernetes Service
apiVersion: v1
kind: Service
metadata:
  name: go-httpbin
  namespace: default
spec:
  ports:
    - port: 8080
      protocol: TCP
  selector:
    app: go-httpbin
---
# Base Deployment
apiVersion: apps/v1
kind: Deployment
metadata:
  name: go-httpbin-base
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: go-httpbin
  template:
    metadata:
      labels:
        app: go-httpbin
    spec:
      containers:
        - image: registry.cn-hangzhou.aliyuncs.com/apig/go-httpbin
          args:
            - "--version=base"
          imagePullPolicy: Always
          name: go-httpbin
---
# Gray Deployment — uses the custom label version: gray
apiVersion: apps/v1
kind: Deployment
metadata:
  name: go-httpbin-gray
  namespace: default
spec:
  replicas: 1
  selector:
    matchLabels:
      app: go-httpbin
  template:
    metadata:
      labels:
        app: go-httpbin
        version: gray
    spec:
      containers:
        - image: registry.cn-hangzhou.aliyuncs.com/apig/go-httpbin
          args:
            - "--version=gray"
          imagePullPolicy: Always
          name: go-httpbin

Ardından Ingress kaynaklarını yapılandırın:

1.19 ve sonraki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "x-user-id"
    nginx.ingress.kubernetes.io/canary-by-header-value: "test"
    # Forward to Pods with label version: gray
    higress.ingress.kubernetes.io/service-subset: gray
    higress.ingress.kubernetes.io/subset-labels: version gray
  name: demo-canary
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: go-httpbin
                port:
                  number: 8080
            path: /test
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/service-subset: ""
  name: demo
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: go-httpbin
                port:
                  number: 8080
            path: /test
            pathType: Exact

1.19'dan önceki sürümlere sahip kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "x-user-id"
    nginx.ingress.kubernetes.io/canary-by-header-value: "test"
    # Forward to Pods with label version: gray
    higress.ingress.kubernetes.io/service-subset: gray
    higress.ingress.kubernetes.io/subset-labels: version gray
  name: demo-canary
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /test
            backend:
              serviceName: go-httpbin
              servicePort: 8080
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/service-subset: ""
  name: demo
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /test
            backend:
              serviceName: go-httpbin
              servicePort: 8080

CORS

Kaynaklar arası kaynak paylaşımı (CORS), hizmetinize hangi harici alan adlarının istekte bulunabileceğini kontrol eder.

Annotation Description Default
nginx.ingress.kubernetes.io/enable-cors CORS özelliğini etkinleştirin veya devre dışı bırakın. —
nginx.ingress.kubernetes.io/cors-allow-origin İzin verilen üçüncü taraf kaynakları. Virgülle ayrılmış; * joker karakterini destekler. * (tüm kaynaklar)
nginx.ingress.kubernetes.io/cors-allow-methods İzin verilen HTTP yöntemleri. Virgülle ayrılmış; * joker karakterini destekler. GET,PUT,POST,DELETE,PATCH,OPTIONS
nginx.ingress.kubernetes.io/cors-allow-headers İzin verilen istek üstbilgileri. Virgülle ayrılmış; * joker karakterini destekler. DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Authorization
nginx.ingress.kubernetes.io/cors-expose-headers Tarayıcının erişmesine izin verilen yanıt üstbilgileri. Virgülle ayrılmış. —
nginx.ingress.kubernetes.io/cors-allow-credentials CORS isteklerinde kimlik bilgilerine izin verilip verilmeyeceği. true
nginx.ingress.kubernetes.io/cors-max-age Ön kontrol yanıtlarının önbellekte tutulma süresi (saniye). 1728000

Örnek: example.com kaynağına izin verin, yalnızca GET ve POST yöntemlerine izin verin, X-Foo-Bar üstbilgisiyle sınırlayın ve kimlik bilgilerine izin vermeyin

Clusters of version 1.19 and later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/enable-cors: "true"
    nginx.ingress.kubernetes.io/cors-allow-origin: "example.com"
    nginx.ingress.kubernetes.io/cors-allow-methods: "GET,POST"
    nginx.ingress.kubernetes.io/cors-allow-headers: "X-Foo-Bar"
    nginx.ingress.kubernetes.io/cors-allow-credentials: "false"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /hello
            pathType: Exact

Clusters earlier than version 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/enable-cors: "true"
    nginx.ingress.kubernetes.io/cors-allow-origin: "example.com"
    nginx.ingress.kubernetes.io/cors-allow-methods: "GET,POST"
    nginx.ingress.kubernetes.io/cors-allow-headers: "X-Foo-Bar"
    nginx.ingress.kubernetes.io/cors-allow-credentials: "false"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service
              servicePort: 80

Regular expression match

Standart Kubernetes Ingress nesneleri yalnızca Exact ve Prefix yol eşleşmesini destekler. APIG Ingress ayrıca düzenli ifade (regex) eşleşmesini de destekler. Bu özelliği nginx.ingress.kubernetes.io/use-regex: "true" ek açıklamasıyla etkinleştirin ve yol değeri olarak bir regex deseni kullanın.

Örnek: /app/... veya /test/... ile eşleşen tüm istekleri demo hizmetine yönlendirin

Clusters running Kubernetes 1.19 or later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/use-regex: "true"
  name: regex-match
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo
                port:
                  number: 8080
            path: /(app|test)/(.*)
            pathType: Prefix

Clusters running Kubernetes earlier than 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/use-regex: "true"
  name: regex-match
  namespace: default
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /(app|test)/(.*)
            backend:
              serviceName: demo
              servicePort: 8080

Path and host rewrite

Yeniden yazma işlemi, APIG Ingress isteği arka uç hizmetine iletmeden önce istekteki yolu veya ana bilgisayarı değiştirir.

Annotation Description
nginx.ingress.kubernetes.io/rewrite-target Yeniden yazma sonrası hedef yol. Yakalama gruplarını destekler.
nginx.ingress.kubernetes.io/upstream-vhost Arka uç hizmetine gönderilen Ana Bilgisayar (Host) üstbilgisi değeri.

Path rewrite

Aşağıdaki tüm örneklerde istek yolunu değiştirmek için nginx.ingress.kubernetes.io/rewrite-target ek açıklaması kullanılır.

Örnek 1: Yönlendirmeden önce example.com/test adresini example.com/dev olarak yeniden yazın

Clusters on Kubernetes 1.19 and Later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: "/dev"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters Before Kubernetes 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: "/dev"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /test
            pathType: Exact
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: /v1 ön ekini kaldırın — example.com/v1/xxx adresini example.com/xxx olarak yeniden yazın

Clusters on Kubernetes 1.19 and Later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: "/$1"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /v1/(.*)
            pathType: Prefix

Clusters Before Kubernetes 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: "/$1"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /v1/(.*)
            pathType: Prefix
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 3: /v1 ön ekini /v2 ile değiştirin — example.com/v1/xxx adresini example.com/v2/xxx olarak yeniden yazın

Clusters on Kubernetes 1.19 and Later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: "/v2/$1"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /v1/(.*)
            pathType: Prefix

Clusters Before Kubernetes 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/rewrite-target: "/v2/$1"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /v1/(.*)
            pathType: Prefix
            backend:
              serviceName: demo-service
              servicePort: 80

Host rewrite

Örnek: Yönlendirmeden önce ana bilgisayarı example.com değerinden test.com değerine yeniden yazın

Clusters on Kubernetes 1.19 and Later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-vhost: "test.com"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters Before Kubernetes 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-vhost: "test.com"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Redirect

HTTP-to-HTTPS redirect

Annotation Description
nginx.ingress.kubernetes.io/ssl-redirect HTTP isteklerini HTTPS'ye yönlendirin.
nginx.ingress.kubernetes.io/force-ssl-redirect HTTP isteklerini HTTPS'ye yönlendirin.

APIG Ingress, ssl-redirect ve force-ssl-redirect ek açıklamalarını aynı şekilde ele alır; her ikisi de HTTP'den HTTPS'ye zorunlu yönlendirme gerçekleştirir.

Örnek: http://example.com/test adresini https://example.com/test adresine yönlendirin

Clusters on Version 1.19 and Later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/ssl-redirect: "true"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters Before Version 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/ssl-redirect: "true"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Permanent redirect

Annotation Description Default
nginx.ingress.kubernetes.io/permanent-redirect Kalıcı yönlendirme için hedef URL. Şema dahil edilmelidir (http:// veya https://). —
nginx.ingress.kubernetes.io/permanent-redirect-code Yönlendirme için HTTP durum kodu. 301

Örnek: http://example.com/test adresini http://example.com/app adresine kalıcı olarak yönlendirin

Clusters on Version 1.19 and Later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/permanent-redirect: "http://example.com/app"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters Before Version 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/permanent-redirect: "http://example.com/app"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Temporary redirect

Geçici bir yönlendirme için hedef URL'yi belirtmek üzere nginx.ingress.kubernetes.io/temporal-redirect ek açıklamasını kullanın. URL şema içermelidir (http:// veya https://).

Örnek: http://example.com/test adresini http://example.com/app adresine geçici olarak yönlendirin

Clusters on Version 1.19 and Later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/temporal-redirect: "http://example.com/app"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters Before Version 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/temporal-redirect: "http://example.com/app"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Header control

Üstbilgi kontrolü, APIG Ingress istekleri arka uç hizmetlere iletirken ve yanıtları istemcilere geri gönderirken HTTP üstbilgilerini eklemenize, güncellemenize veya kaldırmanıza olanak tanır.

Request header control

Üç ek açıklama da aynı çoklu üstbilgi sözdizimini paylaşır: Tek bir üstbilgi için bir anahtar-değer çifti kullanılır; birden fazla üstbilgi için YAML | blok skaleri kullanılır ve her satıra bir anahtar-değer çifti yazılır.

Annotation Description
higress.ingress.kubernetes.io/request-header-control-add İletilen isteğe bir üstbilgi ekler. Üstbilgi zaten varsa değer sonuna eklenir.
higress.ingress.kubernetes.io/request-header-control-update İletilen istekteki bir üstbilgiyi günceller. Üstbilgi zaten varsa değerin üzerine yazılır.
higress.ingress.kubernetes.io/request-header-control-remove İletilen istekten bir üstbilgiyi kaldırır. Birden fazla üstbilgi adını virgülle ayırın.

Örnek 1: example.com/test adresine yapılan tüm isteklere foo: bar ve test: true üstbilgilerini ekleyin

Clusters running Kubernetes 1.19 or later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/request-header-control-add: |
      foo bar
      test true
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters running Kubernetes earlier than 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/request-header-control-add: |
      foo bar
      test true
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: Canary sürümleriyle birlikte üstbilgi kontrolünü kullanarak trafiği dağıtım aşamasına göre etiketleyin

İstek üstbilgisinde apig: v1 bulunduğunda, APIG Ingress canary sürümüne yönlendirme yapar ve stage: gray üstbilgisini ekler. Diğer tüm istekler temel sürüme gider ve stage: production üstbilgisini alır.

Clusters running Kubernetes 1.19 or later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "apig"
    nginx.ingress.kubernetes.io/canary-by-header-value: "v1"
    higress.ingress.kubernetes.io/request-header-control-add: "stage gray"
  name: demo-canary-v1
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service-canary-v1
                port:
                  number: 80
            path: /hello
            pathType: Exact
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/request-header-control-add: "stage production"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /hello
            pathType: Exact

Clusters running Kubernetes earlier than 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/canary: "true"
    nginx.ingress.kubernetes.io/canary-by-header: "apig"
    nginx.ingress.kubernetes.io/canary-by-header-value: "v1"
    higress.ingress.kubernetes.io/request-header-control-add: "stage gray"
  name: demo-canary-v1
spec:
  ingressClassName: apig
  rules:
    - http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service-canary-v1
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/request-header-control-add: "stage production"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /hello
            backend:
              serviceName: demo-service
              servicePort: 80

Response header control

Annotation Description
higress.ingress.kubernetes.io/response-header-control-add İstemciye iletilmeden önce yanıta bir üstbilgi ekler. Üstbilgi zaten varsa değer sonuna eklenir.
higress.ingress.kubernetes.io/response-header-control-update İstemciye iletilmeden önce yanıtta bir üstbilgiyi günceller. Üstbilgi zaten varsa değerin üzerine yazılır.
higress.ingress.kubernetes.io/response-header-control-remove İstemciye iletilmeden önce yanıttan bir üstbilgiyi kaldırır. Birden fazla üstbilgi adını virgülle ayırın.

Örnek: example.com/test adresine yönelik yanıtlardan req-cost-time üstbilgisini kaldırın

Clusters running Kubernetes 1.19 or later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/response-header-control-remove: "req-cost-time"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters running Kubernetes earlier than 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/response-header-control-remove: "req-cost-time"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Retry

APIG Ingress, rotasyon düzeyinde başarısız istekleri otomatik olarak yeniden dener. Maksimum yeniden deneme sayısını, zaman aşımını ve yeniden denemeyi tetikleyen koşulları yapılandırabilirsiniz.

Annotation Description Default
nginx.ingress.kubernetes.io/proxy-next-upstream-tries Maksimum yeniden deneme sayısı. 3
nginx.ingress.kubernetes.io/proxy-next-upstream-timeout Yeniden denemeler için zaman aşımı (saniye). Zaman aşımı yok
nginx.ingress.kubernetes.io/proxy-next-upstream Yeniden deneme koşullarının virgülle ayrılmış listesi. error,timeout

Geçerli yeniden deneme koşulları:

Condition Description
error Bağlantı kurulumu başarısız olur veya 5xx durum kodu döndürülür.
timeout Bağlantı kurulumu zaman aşımına uğrar veya 5xx durum kodu döndürülür.
invalid_header Bir istek hatası oluşur veya 5xx durum kodu döndürülür.
http_xxx Belirli bir HTTP durum kodunda yeniden deneyin (örneğin, http_502, http_403).
non_idempotent Idempotent olmayan istekler (POST, PATCH) için yeniden denemeleri etkinleştirin. Varsayılan olarak bunlar yeniden denenmez.
off Yeniden denemeleri tamamen devre dışı bırakın.

Örnek: 5 saniye içinde en fazla 2 kez yeniden deneyin, yalnızca HTTP 502 durumunda ve ayrıca idempotent olmayan istekleri yeniden deneyin

Clusters for Kubernetes 1.19 and Later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/proxy-next-upstream-tries: "2"
    nginx.ingress.kubernetes.io/proxy-next-upstream-timeout: "5"
    nginx.ingress.kubernetes.io/proxy-next-upstream: "http_502,non_idempotent"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters for Kubernetes Earlier Than 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/proxy-next-upstream-tries: "2"
    nginx.ingress.kubernetes.io/proxy-next-upstream-timeout: "5"
    nginx.ingress.kubernetes.io/proxy-next-upstream: "http_502,non_idempotent"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

IP access control

APIG Ingress, hem rota düzeyinde hem de alan adı düzeyinde IP adresi izin listelerini ve engelleme listelerini destekler. Rota düzeyindeki kurallar, alan adı düzeyindeki kurallara göre önceliklidir.

Route-level IP access control

Annotation Description
nginx.ingress.kubernetes.io/whitelist-source-range Belirli bir rota için izin listesi. IP adreslerini ve CIDR bloklarını kabul eder, virgülle ayrılır.
higress.ingress.kubernetes.io/blacklist-source-range Belirli bir rota için engelleme listesi. IP adreslerini ve CIDR bloklarını kabul eder, virgülle ayrılır.

Örnek 1: example.com/test adresine yalnızca 1.1.X.X adresinden erişime izin verin

Clusters of version 1.19 and later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/whitelist-source-range: 1.1.X.X
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters earlier than version 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/whitelist-source-range: 1.1.X.X
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: example.com/test adresine 2.2.2.2 adresinden erişimi engelleyin

Clusters of version 1.19 and later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/blacklist-source-range: 2.2.2.2
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters earlier than version 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/blacklist-source-range: 2.2.2.2
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Domain-level IP access control

Annotation Description
higress.ingress.kubernetes.io/domain-whitelist-source-range Bir alan adı altındaki tüm rotalara uygulanan izin listesi. Rota düzeyindeki izin listeleri önceliklidir. IP adreslerini ve CIDR bloklarını kabul eder, virgülle ayrılır.
higress.ingress.kubernetes.io/domain-blacklist-source-range Bir alan adı altındaki tüm rotalara uygulanan engelleme listesi. Rota düzeyindeki engelleme listeleri önceliklidir. IP adreslerini ve CIDR bloklarını kabul eder, virgülle ayrılır.

Örnek 1: example.com altındaki tüm rotalara 1.1.X.X ve 2.2.2.2 adreslerinden erişime izin verin

Clusters of version 1.19 and later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/domain-whitelist-source-range: 1.1.X.X,2.2.2.2
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact
          - backend:
              service:
                name: app-service
                port:
                  number: 80
            path: /app
            pathType: Exact

Clusters earlier than version 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/domain-whitelist-source-range: 1.1.X.X,2.2.2.2
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80
          - path: /app
            backend:
              serviceName: app-service
              servicePort: 80

Örnek 2: Alan adı düzeyi ve rota düzeyi izin listelerini birleştirin — /order rotasını 3.3.X.X ile sınırlayın, diğer tüm rotalarda ise 1.1.X.X ve 2.2.2.2 adreslerine izin verin

Clusters of version 1.19 and later

# Domain-level allowlist for /test and /app
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/domain-whitelist-source-range: 1.1.X.X,2.2.2.2
  name: demo-domain
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact
          - backend:
              service:
                name: app-service
                port:
                  number: 80
            path: /app
            pathType: Exact
---
# Route-level allowlist overrides domain-level for /order
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/whitelist-source-range: 3.3.X.X
  name: demo-route
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /order
            pathType: Exact

Clusters earlier than version 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/domain-whitelist-source-range: 1.1.X.X,2.2.2.2
  name: demo-domain
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80
          - path: /app
            backend:
              serviceName: app-service
              servicePort: 80
---
apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/whitelist-source-range: 3.3.X.X
  name: demo-route
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /order
            backend:
              serviceName: demo-service
              servicePort: 80

Single-gateway throttling

Tek ağ geçidi kısıtlaması, her Cloud-native API Gateway örneğinde belirli bir rota için istek oranını sınırlar. Sınır, tüm küme genelinde değil, ağ geçidi çoğaltması başına uygulanır.

Önemli

Oran sınırları ağ geçidi çoğaltması başına uygulanır. Birden fazla çoğaltma çalıştırıyorsanız veya Yatay Pod Otomatik Ölçeklendirici (HPA) kullanıyorsanız, küme genelindeki etkili sınır, yapılandırılan değerin çoğaltma sayısı ile çarpılmasıyla elde edilir. Çoğaltma sayısından etkilenmeyen küme genelinde bir sınır için bunun yerine global throttling control kullanın.

Annotation Description Default
higress.ingress.kubernetes.io/route-limit-rpm Ağ geçidi örneği başına dakika başına maksimum istek sayısı (RPM). Sınır aşıldığında yanıt gövdesi local_rate_limited olur. —
higress.ingress.kubernetes.io/route-limit-rps Ağ geçidi örneği başına saniye başına maksimum istek sayısı (RPS). Sınır aşıldığında yanıt gövdesi local_rate_limited olur. —
higress.ingress.kubernetes.io/route-limit-burst-multiplier Patlama limiti çarpanı. Patlama limiti, RPM veya RPS değerinin bu sayı ile çarpılmasına eşittir. 5

Kısıtlama tetiklendiğinde yanıt durum kodu, ağ geçidi sürümünüzüne bağlıdır:

  • 1.2.23'ten önceki ağ geçidi sürümü: HTTP 503

  • 1.2.23 veya sonraki ağ geçidi sürümü: HTTP 429

Örnek 1: example.com/test adresini dakikada 100 istekle (RPM) ve 200 patlama limitiyle (çarpan 2) sınırlayın

Clusters running Kubernetes 1.19 or later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/route-limit-rpm: "100"
    higress.ingress.kubernetes.io/route-limit-burst-multiplier: "2"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters running Kubernetes earlier than 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/route-limit-rpm: "100"
    higress.ingress.kubernetes.io/route-limit-burst-multiplier: "2"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: example.com/test adresini saniyede 10 istekle (RPS) ve varsayılan patlama limitiyle (çarpan 5, patlama = 50) sınırlayın

Clusters running Kubernetes 1.19 or later

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/route-limit-rps: "10"
    # Default burst multiplier is 5; burst limit = 50
    # higress.ingress.kubernetes.io/route-limit-burst-multiplier: "5"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Clusters running Kubernetes earlier than 1.19

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/route-limit-rps: "10"
    # Default burst multiplier is 5; burst limit = 50
    # higress.ingress.kubernetes.io/route-limit-burst-multiplier: "5"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Global throttle kontrolü

Bu özellik APIG Ingress gateway 1.2.25 veya üzeri sürümü gerektirir.

Global throttle kontrolü, Sentinel ile entegre çalışarak belirli bir route üzerinde küme genelinde RPS (saniye başına istek) sınırı uygular. Sınır aşıldığında varsayılan yanıt HTTP 429 durum kodu ve sentinel rate limited gövdesidir. Bu davranışı özel bir yanıtla veya yönlendirmeyle geçersiz kılabilirsiniz; ancak ikisini aynı anda kullanamazsınız.

Özel yanıt

Annotation Açıklama Varsayılan
higress.ingress.kubernetes.io/rate-limit Ağ geçidi kümesi genelinde route için maksimum RPS değeri. —
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-code Throttle tetiklendiğinde döndürülen HTTP durum kodu. 429
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body-type Yanıt gövdesi formatı: text (text/plain; charset=UTF-8) veya json (application/json; charset=UTF-8). text
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body Throttle tetiklendiğinde döndürülen yanıt gövde içeriği. sentinel rate limited

Örnek 1: example.com/test yolunu varsayılan throttle yanıtıyla 100 RPS ile sınırlayın

1.19 ve üzeri sürümlerdeki kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/rate-limit: "100"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

1.19 öncesi sürümlerdeki kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/rate-limit: "100"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: example.com/test yolunu 100 RPS ile sınırlayın; throttle tetiklendiğinde HTTP 503 ve server is overload gövdesi döndürün

1.19 ve üzeri sürümlerdeki kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/rate-limit: "100"
    higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-code: "503"
    higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body: "server is overload"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

1.19 öncesi sürümlerdeki kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/rate-limit: "100"
    higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-code: "503"
    higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body: "server is overload"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Yönlendirme

Throttle tetiklendiğinde istemcileri bir yedek URL'ye yönlendirmek için higress.ingress.kubernetes.io/rate-limit-fallback-redirect-url annotation'ını kullanın.

Örnek: example.com/test yolunu 100 RPS ile sınırlayın; throttle tetiklendiğinde example.com/fallback adresine yönlendirin

1.19 ve üzeri sürümlerdeki kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/rate-limit: "100"
    higress.ingress.kubernetes.io/rate-limit-fallback-redirect-url: "example.com/fallback"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

1.19 öncesi sürümlerdeki kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/rate-limit: "100"
    higress.ingress.kubernetes.io/rate-limit-fallback-redirect-url: "example.com/fallback"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Global eşzamanlılık kontrolü

Bu özellik APIG Ingress gateway 1.2.25 veya üzeri sürümü gerektirir.

Global eşzamanlılık kontrolü, Sentinel ile entegre çalışarak belirli bir route için küme genelinde eşzamanlı istek sınırı uygular. Sınır aşıldığında varsayılan yanıt HTTP 429 durum kodu ve sentinel rate limited gövdesidir. Bu durumu özel bir yanıtla veya yönlendirmeyle geçersiz kılabilirsiniz; ancak ikisini aynı anda kullanamazsınız.

Özel yanıt

Annotation Açıklama Varsayılan
higress.ingress.kubernetes.io/concurrency-limit Ağ geçidi kümesi genelinde route için maksimum eşzamanlı istek sayısı. —
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-code Eşzamanlılık kontrolü tetiklendiğinde döndürülen HTTP durum kodu. 429
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body-type Yanıt gövdesi formatı: text (text/plain; charset=UTF-8) veya json (application/json; charset=UTF-8). text
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body Eşzamanlılık kontrolü tetiklendiğinde döndürülen yanıt gövde içeriği. sentinel rate limited

Örnek 1: example.com/test yolundaki eşzamanlı istekleri varsayılan yanıtla 1.000 ile sınırlayın

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/concurrency-limit: "1000"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/concurrency-limit: "1000"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: Eşzamanlı istekleri 1.000 ile sınırlayın; sınır aşıldığında HTTP 503 ve server is overloaded gövdesi döndürün

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/concurrency-limit: "1000"
    higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-code: "503"
    higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body: "server is overload"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/concurrency-limit: "1000"
    higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-code: "503"
    higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body: "server is overload"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Yönlendirme

Eşzamanlılık kontrolü tetiklendiğinde istemcileri bir yedek URL'ye yönlendirmek için higress.ingress.kubernetes.io/concurrency-limit-fallback-redirect-url annotation'ını kullanın.

Örnek: Eşzamanlı istekleri 1.000 ile sınırlayın; sınır aşıldığında example.com/fallback adresine yönlendirin

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/concurrency-limit: "1000"
    higress.ingress.kubernetes.io/concurrency-limit-fallback-redirect-url: "example.com/fallback"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/concurrency-limit: "1000"
    higress.ingress.kubernetes.io/concurrency-limit-fallback-redirect-url: "example.com/fallback"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Trafik yansıtma

Trafik yansıtma, canlı istek trafiğini orijinal istek akışını etkilemeden bir shadow hizmete kopyalar. Bu özelliği operasyonel denetim, trafik testi veya yeni hizmet sürümlerini shadow modunda doğrulamak için kullanın.

Annotation Açıklama Varsayılan
higress.ingress.kubernetes.io/mirror-target-service Yansıtılan trafik için hedef hizmet. Format: namespace/name:port. namespace ve port alanları isteğe bağlıdır; namespace varsayılan olarak Ingress gateway'in ad alanını, port ise hizmetin ilk bağlantı noktasını alır. —
higress.ingress.kubernetes.io/mirror-percentage Yansıtılacak trafik yüzdesi. Geçerli değerler: 0–100. 100
Önemli

Yansıtılan trafik hedef hizmete iletildiğinde APIG Ingress, Host header'ının sonuna otomatik olarak -shadow ekler. Örneğin, example.com değeri example.com-shadow haline gelir. Hedef hizmet yönlendirme veya günlük kaydı için Host header'ını kullanıyorsa hizmet yapılandırmanızda bu değişikliği dikkate alın.

Örnek 1: example.com/test yolundaki tüm trafiği test/app:8080 adresine yansıtın

1.19 ve Üzeri Sürüm Çalışan Kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/mirror-target-service: test/app:8080
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

1.19 Öncesi Sürüm Çalışan Kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/mirror-target-service: test/app:8080
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: example.com/test yolundaki trafiğin %10'unu test/app:8080 adresine yansıtın

1.19 ve Üzeri Sürüm Çalışan Kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/mirror-target-service: test/app:8080
    higress.ingress.kubernetes.io/mirror-percentage: "10"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

1.19 Öncesi Sürüm Çalışan Kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/mirror-target-service: test/app:8080
    higress.ingress.kubernetes.io/mirror-percentage: "10"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Arka uç hizmet protokolleri

APIG Ingress varsayılan olarak istekleri arka uç hizmetlere HTTP üzerinden iletir. HTTPS veya gRPC kullanmak için nginx.ingress.kubernetes.io/backend-protocol annotation'ını kullanın.

Bir Kubernetes Service kaynağında bağlantı noktası adı grpc veya http2 olarak ayarlanırsa APIG Ingress, annotation olmadan otomatik olarak o arka uç için gRPC veya HTTP/2 kullanır. Bu durum, her durumda annotation gerektiren NGINX Ingress'ten farklıdır.

Örnek 1: İstekleri bir HTTPS arka uca iletin

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: İstekleri bir gRPC arka uca iletin

İki yöntem mevcuttur: annotation (açık) veya Service bağlantı noktası adı (yapılandırmadan ziyade kural).

Yöntem 1 — annotation:

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/backend-protocol: "GRPC"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/backend-protocol: "GRPC"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Yöntem 2 — Service bağlantı noktası adı (grpc):

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /order
            pathType: Exact
---
apiVersion: v1
kind: Service
metadata:
  name: demo-service
spec:
  ports:
    - name: grpc  # APIG Ingress detects this and automatically uses gRPC
      port: 80
      protocol: TCP
  selector:
    app: demo-service

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80
---
apiVersion: v1
kind: Service
metadata:
  name: demo-service
spec:
  ports:
    - name: grpc
      port: 80
      protocol: TCP
  selector:
    app: demo-service

Arka uç hizmetleri için yük dengeleme algoritmaları

Yük dengeleme algoritmaları, ağ geçidinin istekleri iletirken hangi arka uç düğümlerini seçeceğini belirler.

Yaygın yük dengeleme algoritmaları

Algoritmayı ayarlamak için nginx.ingress.kubernetes.io/load-balance annotation'ını kullanın.

Değer Açıklama
round_robin İstekleri arka uç düğümleri arasında sırayla dağıtır. Bu varsayılan değerdir.
least_conn Her isteği en az aktif bağlantıya sahip düğüme yönlendirir.
random Bir arka uç düğümünü rastgele seçer.
Önemli

APIG Ingress üstel ağırlıklı hareketli ortalama (EWMA) algoritmasını desteklemez. EWMA yapılandırılırsa sistem round_robin algoritmasına geri döner.

Örnek: demo-service arka ucu için en az bağlantı algoritmasını kullanın

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/load-balance: "least_conn"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /order
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/load-balance: "least_conn"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Tutarlı karma tabanlı yük dengeleme algoritmaları

Tutarlı karma, aynı anahtara sahip isteklerin her zaman aynı arka uç düğümüne yönlendirilmesini sağlar; bu durum oturum farkındalığı olan uygulamalar veya önbellek yerel ilişkisi için kullanışlıdır. Karma anahtarını ayarlamak için nginx.ingress.kubernetes.io/upstream-hash-by annotation'ını kullanın.

Desteklenen karma anahtar türleri:

Karma anahtarı Yapılandırma Açıklama
İstek URI'si $request_uri Yol parametrelerini içerir.
Host $host İstek host header'ı.
İstemci IP'si $remote_addr İstemci IP adresi.
İstek header'ı $http_<header-name> Belirli bir istek header'ının değeri.
Sorgu parametresi $arg_<param-name> Belirli bir URL sorgu parametresinin değeri.

Örnek 1: Aynı istemci IP'sinden gelen tüm istekleri aynı arka uç düğümüne yönlendirin

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-hash-by: "$remote_addr"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-hash-by: "$remote_addr"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: Aynı X-Stage header değerine sahip istekleri aynı arka uç düğümüne yönlendirin

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-hash-by: "$http_x-stage"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-hash-by: "$http_x-stage"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 3: Aynı X-Stage sorgu parametresi değerine sahip istekleri aynı arka uç düğümüne yönlendirin

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_x-stage"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/upstream-hash-by: "$arg_x-stage"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Warmup (yumuşak başlatma)

Warmup, yeni başlatılan bir arka uç düğümüne belirtilen zaman aralığında kademeli olarak trafik göndererek düğümün yoğun trafiği karşılamadan önce önbellekleri başlatmasına ve JIT derlemesi yapmasına olanak tanır.

Warmup penceresini saniye cinsinden ayarlamak için higress.ingress.kubernetes.io/warmup annotation'ını kullanın. Warmup varsayılan olarak devre dışıdır.

Warmup yalnızca round_robin ve least_conn yük dengeleme algoritmalarıyla desteklenir.

Örnek: demo-service için 30 saniyelik warmup penceresi ayarlayın

Kubernetes 1.19 ve üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/warmup: "30"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/warmup: "30"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Cookie benzeşimi (oturum kalıcılığı)

Cookie benzeşimi, aynı istemciden gelen tüm istekleri aynı arka uç düğümüne yönlendirir. APIG Ingress ilk istekte bir benzeşim cookie'si oluşturur; sonraki istekler bu cookie'yi taşır ve aynı düğüme yönlendirilir.

Annotation Açıklama Varsayılan
nginx.ingress.kubernetes.io/affinity Benzeşim türü. Tek geçerli değer cookie değeridir. —
nginx.ingress.kubernetes.io/affinity-mode Benzeşim modu: balanced yeni oturumları arka uçlar arasında eşit dağıtır; persistent cookie'nin ömrü boyunca her zaman aynı arka uca yönlendirir. balanced
nginx.ingress.kubernetes.io/session-cookie-name Karma anahtarı olarak kullanılan cookie adı. INGRESSCOOKIE
nginx.ingress.kubernetes.io/session-cookie-path Oluşturulan cookie yolu. Ingress yoluyla eşleşmelidir. /
nginx.ingress.kubernetes.io/session-cookie-max-age Oluşturulan cookie'nin saniye cinsinden son kullanma süresi. session-cookie-expires değerine göre önceliklidir. Oturum düzeyi
nginx.ingress.kubernetes.io/session-cookie-expires Oluşturulan cookie'nin saniye cinsinden son kullanma süresi. Oturum düzeyi

Örnek 1: Varsayılan ayarlarla cookie benzeşimini etkinleştirin (cookie adı INGRESSCOOKIE, yol /, oturum düzeyi ömür)

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/affinity: "cookie"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/affinity: "cookie"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Örnek 2: Özel cookie adı test, yol / ve 10 saniyelik son kullanma süresiyle cookie benzeşimini etkinleştirin

Kubernetes 1.19 veya üzeri sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/affinity: "cookie"
    nginx.ingress.kubernetes.io/session-cookie-name: "test"
    nginx.ingress.kubernetes.io/session-cookie-max-age: "10"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes 1.19 öncesi sürüm çalışan kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/affinity: "cookie"
    nginx.ingress.kubernetes.io/session-cookie-name: "test"
    nginx.ingress.kubernetes.io/session-cookie-max-age: "10"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Bağlantı havuzu

Bağlantı havuzları, bir ağ geçidi örneğinin arka uç hizmete açtığı bağlantı sayısını sınırlayarak yüksek trafik altında aşırı yüklenmeyi önler.

Annotation Açıklama
higress.ingress.kubernetes.io/connection-policy-tcp-max-connection Ağ geçidi örneği ile arka uç hizmet arasındaki toplam maksimum TCP bağlantısı sayısı.
higress.ingress.kubernetes.io/connection-policy-tcp-max-connection-per-endpoint Ağ geçidi örneği ile tek bir arka uç Pod'u arasındaki maksimum TCP bağlantısı sayısı.
higress.ingress.kubernetes.io/connection-policy-http-max-request-per-connection Ağ geçidi örneği ile arka uç hizmet arasındaki her TCP bağlantısı başına maksimum HTTP isteği sayısı.

Örnek: demo-service için ağ geçidini toplam 10 bağlantı ve Pod başına 2 bağlantı ile sınırlayın

1.19 ve Üzeri Sürümlerdeki Kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/connection-policy-tcp-max-connection: "10"
    higress.ingress.kubernetes.io/connection-policy-tcp-max-connection-per-endpoint: "2"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

1.19 Öncesi Sürümlerdeki Kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/connection-policy-tcp-max-connection: "10"
    higress.ingress.kubernetes.io/connection-policy-tcp-max-connection-per-endpoint: "2"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

TLS sürümleri ve şifre takımları

APIG Ingress, varsayılan olarak TLS 1.0'dan TLS 1.3'e kadar olan bağlantıları aşağıdaki şifre takımlarını kullanarak kabul eder:

  • ECDHE-ECDSA-AES128-GCM-SHA256

  • ECDHE-RSA-AES128-GCM-SHA256

  • ECDHE-ECDSA-AES128-SHA

  • ECDHE-RSA-AES128-SHA

  • AES128-GCM-SHA256

  • AES128-SHA

  • ECDHE-ECDSA-AES256-GCM-SHA384

  • ECDHE-RSA-AES256-GCM-SHA384

  • ECDHE-ECDSA-AES256-SHA

  • ECDHE-RSA-AES256-SHA

  • AES256-GCM-SHA384

  • AES256-SHA

Belirli bir alan adı için TLS sürüm aralığını veya şifre takımlarını kısıtlamak amacıyla aşağıdaki ek açıklamaları kullanın:

Ek Açıklama Açıklama Varsayılan
higress.ingress.kubernetes.io/tls-min-protocol-version Minimum TLS sürümü. Geçerli değerler: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. TLSv1.0
higress.ingress.kubernetes.io/tls-max-protocol-version Maksimum TLS sürümü. Geçerli değerler: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. TLSv1.3
nginx.ingress.kubernetes.io/ssl-cipher İzin verilen şifre takımları (virgülle ayrılmış). Yalnızca TLS 1.0–1.2 el sıkışmaları için geçerlidir. —

Örnek: example.com alan adını yalnızca TLS 1.2 ile sınırlama

1.19 ve sonraki sürümlerdeki kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/tls-min-protocol-version: "TLSv1.2"
    higress.ingress.kubernetes.io/tls-max-protocol-version: "TLSv1.2"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

1.19 öncesindeki sürümlerdeki kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    higress.ingress.kubernetes.io/tls-min-protocol-version: "TLSv1.2"
    higress.ingress.kubernetes.io/tls-max-protocol-version: "TLSv1.2"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80

Arka uç hizmetleriyle mTLS kimlik doğrulaması

Tek yönlü TLS (nginx.ingress.kubernetes.io/backend-protocol: "HTTPS" aracılığıyla; Arka uç hizmeti protokolleri bölümünde açıklanmıştır) yalnızca arka ucun sertifikasını doğrular. Karşılıklı doğrulama için mTLS yapılandırın; bu sayede arka uç, ağ geçidi tarafından sunulan istemci sertifikasını da doğrular.

Ağ geçidinin sunduğu istemci sertifikasını yapılandırmak için şu ek açıklamaları kullanın:

Ek Açıklama Açıklama
nginx.ingress.kubernetes.io/proxy-ssl-secret Ağ geçidinin kendisini arka uç hizmetine doğrulamak için kullandığı istemci sertifikası. Biçim: secretNamespace/secretName.
nginx.ingress.kubernetes.io/proxy-ssl-name TLS el sıkışması sırasında kullanılan Sunucu Adı Göstergesi (SNI) değeri.
nginx.ingress.kubernetes.io/proxy-ssl-server-name TLS el sıkışması sırasında SNI özelliğini etkinleştirin veya devre dışı bırakın.

Örnek: default/gateway-cert sertifikasını kullanarak ağ geçidi ile demo-service arasında mTLS yapılandırma

Kubernetes 1.19 veya sonraki sürümleri çalıştıran kümeler

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
    nginx.ingress.kubernetes.io/proxy-ssl-secret: "default/gateway-cert"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - backend:
              service:
                name: demo-service
                port:
                  number: 80
            path: /test
            pathType: Exact

Kubernetes'in 1.19 öncesindeki sürümlerini çalıştıran kümeler

apiVersion: networking.k8s.io/v1beta1
kind: Ingress
metadata:
  annotations:
    nginx.ingress.kubernetes.io/backend-protocol: "HTTPS"
    nginx.ingress.kubernetes.io/proxy-ssl-secret: "default/gateway-cert"
  name: demo
spec:
  ingressClassName: apig
  rules:
    - host: example.com
      http:
        paths:
          - path: /test
            backend:
              serviceName: demo-service
              servicePort: 80