APIG Ingress, sorunsuz geçiş için 51 NGINX Ingress ek açıklamasını ve trafik yönetimi ile güvenlik için 40 genişletilmiş ek açıklamayı destekler.
Ek açıklama desteği özeti
| Kategori | Sayı | Açıklama |
|---|---|---|
| NGINX Ingress uyumlu ek açıklamalar | 51 | Kullanım durumlarının %90'ını kapsar |
| İşlevsel etkisi olmayan ek açıklamalar | 15 | Yapılandırma gerekmez |
| Desteklenecek ek açıklamalar | 48 | Planlandı; sınırlı senaryolarda kullanılır |
| Desteklenmeyen ek açıklamalar | 5 | NGINX Ingress iç kod parçacıklarına özeldir |
| APIG genişletilmiş ek açıklamaları | 40 | NGINX Ingress'in ötesinde ek trafik yönetimi ve güvenlik kontrolleri |
Hızlı başvuru
Tam açıklamasını görüntülemek için bir ek açıklamayı tıklayın.
| Ek Açıklama | Kapsam | Durum | Varsayılan | Kategori |
|---|---|---|---|---|
nginx.ingress.kubernetes.io/canary |
Ingress | Uyumlu | — | Canary sürümü |
nginx.ingress.kubernetes.io/canary-by-header |
Ingress | Uyumlu | — | Canary sürümü |
nginx.ingress.kubernetes.io/canary-by-header-value |
Ingress | Uyumlu | — | Canary sürümü |
nginx.ingress.kubernetes.io/canary-by-header-pattern |
Ingress | Uyumlu | — | Canary sürümü |
higress.ingress.kubernetes.io/canary-by-query |
Ingress | Higress uzantısı | — | Canary sürümü |
higress.ingress.kubernetes.io/canary-by-query-value |
Ingress | Higress uzantısı | — | Canary sürümü |
higress.ingress.kubernetes.io/canary-by-query-pattern |
Ingress | Higress uzantısı | — | Canary sürümü |
nginx.ingress.kubernetes.io/canary-by-cookie |
Ingress | Uyumlu | — | Canary sürümü |
higress.ingress.kubernetes.io/canary-by-cookie-value |
Ingress | Higress uzantısı (V1.2.30+) | — | Canary sürümü |
nginx.ingress.kubernetes.io/canary-weight |
Ingress | Uyumlu | — | Canary sürümü |
nginx.ingress.kubernetes.io/canary-weight-total |
Ingress | Uyumlu | — | Canary sürümü |
higress.ingress.kubernetes.io/destination |
Ingress | Higress uzantısı | — | Çok hizmetli yönlendirme |
higress.ingress.kubernetes.io/service-subset |
Ingress | Higress uzantısı (V1.2.25+) | — | Hizmet alt kümeleri |
higress.ingress.kubernetes.io/subset-labels |
Ingress | Higress uzantısı (V1.2.25+) | — | Hizmet alt kümeleri |
nginx.ingress.kubernetes.io/default-backend |
Ingress | Uyumlu | — | Geri dönüş |
nginx.ingress.kubernetes.io/custom-http-errors |
Ingress | Uyumlu | — | Geri dönüş |
nginx.ingress.kubernetes.io/use-regex |
Ingress | Uyumlu | — | Regex eşleşmesi |
nginx.ingress.kubernetes.io/rewrite-target |
Ingress | Uyumlu | — | Yeniden yazma |
nginx.ingress.kubernetes.io/upstream-vhost |
Ingress | Uyumlu | — | Yeniden yazma |
nginx.ingress.kubernetes.io/ssl-redirect |
Ingress | Uyumlu | — | Yönlendirme |
nginx.ingress.kubernetes.io/force-ssl-redirect |
Ingress | Uyumlu | — | Yönlendirme |
nginx.ingress.kubernetes.io/permanent-redirect |
Ingress | Uyumlu | — | Yönlendirme |
nginx.ingress.kubernetes.io/permanent-redirect-code |
Ingress | Uyumlu | — | Yönlendirme |
nginx.ingress.kubernetes.io/temporal-redirect |
Ingress | Uyumlu | — | Yönlendirme |
nginx.ingress.kubernetes.io/app-root |
Ingress | Uyumlu | — | Yönlendirme |
nginx.ingress.kubernetes.io/enable-cors |
Ingress | Uyumlu | — | CORS |
nginx.ingress.kubernetes.io/cors-allow-origin |
Ingress | Uyumlu | — | CORS |
nginx.ingress.kubernetes.io/cors-allow-methods |
Ingress | Uyumlu | — | CORS |
nginx.ingress.kubernetes.io/cors-allow-headers |
Ingress | Uyumlu | — | CORS |
nginx.ingress.kubernetes.io/cors-expose-headers |
Ingress | Uyumlu | — | CORS |
nginx.ingress.kubernetes.io/cors-allow-credentials |
Ingress | Uyumlu | — | CORS |
nginx.ingress.kubernetes.io/cors-max-age |
Ingress | Uyumlu | — | CORS |
higress.ingress.kubernetes.io/request-header-control-add |
Ingress | Higress uzantısı | — | Üst bilgi kontrolü |
higress.ingress.kubernetes.io/request-header-control-update |
Ingress | Higress uzantısı | — | Üst bilgi kontrolü |
higress.ingress.kubernetes.io/request-header-control-remove |
Ingress | Higress uzantısı | — | Üst bilgi kontrolü |
higress.ingress.kubernetes.io/response-header-control-add |
Ingress | Higress uzantısı | — | Üst bilgi kontrolü |
higress.ingress.kubernetes.io/response-header-control-update |
Ingress | Higress uzantısı | — | Üst bilgi kontrolü |
higress.ingress.kubernetes.io/response-header-control-remove |
Ingress | Higress uzantısı | — | Üst bilgi kontrolü |
higress.ingress.kubernetes.io/timeout |
Ingress | Higress uzantısı | Yok | Zaman aşımı |
nginx.ingress.kubernetes.io/proxy-next-upstream-tries |
Ingress | Uyumlu | 3 |
Yeniden deneme |
nginx.ingress.kubernetes.io/proxy-next-upstream-timeout |
Ingress | Uyumlu | Yok | Yeniden deneme |
nginx.ingress.kubernetes.io/proxy-next-upstream |
Ingress | Uyumlu | — | Yeniden deneme |
higress.ingress.kubernetes.io/mirror-target-service |
Ingress | Higress uzantısı | — | Trafik yansıtma |
higress.ingress.kubernetes.io/mirror-percentage |
Ingress | Higress uzantısı (V1.2.32+) | 100 |
Trafik yansıtma |
nginx.ingress.kubernetes.io/server-alias |
Etki alanı adı | Kısmen uyumlu (V1.2.30+) | — | Etki alanı takma adı |
higress.ingress.kubernetes.io/route-limit-rpm |
Ingress | Higress uzantısı | — | Hız sınırlama (kullanımdan kaldırıldı) |
higress.ingress.kubernetes.io/route-limit-rps |
Ingress | Higress uzantısı | — | Hız sınırlama (kullanımdan kaldırıldı) |
higress.ingress.kubernetes.io/route-limit-burst-multiplier |
Ingress | Higress uzantısı | 5 |
Hız sınırlama (kullanımdan kaldırıldı) |
higress.ingress.kubernetes.io/rate-limit |
Ingress | Higress uzantısı (V1.2.25+) | — | Genel kısıtlama |
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-code |
Ingress | Higress uzantısı (V1.2.25+) | 429 |
Genel kısıtlama |
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body-type |
Ingress | Higress uzantısı (V1.2.25+) | text |
Genel kısıtlama |
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body |
Ingress | Higress uzantısı (V1.2.25+) | sentinel rate limited |
Genel kısıtlama |
higress.ingress.kubernetes.io/rate-limit-fallback-redirect-url |
Ingress | Higress uzantısı (V1.2.25+) | — | Genel kısıtlama |
higress.ingress.kubernetes.io/concurrency-limit |
Ingress | Higress uzantısı (V1.2.25+) | — | Genel eşzamanlılık |
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-code |
Ingress | Higress uzantısı (V1.2.25+) | 429 |
Genel eşzamanlılık |
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body-type |
Ingress | Higress uzantısı (V1.2.25+) | text |
Genel eşzamanlılık |
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body |
Ingress | Higress uzantısı (V1.2.25+) | sentinel rate limited |
Genel eşzamanlılık |
higress.ingress.kubernetes.io/concurrency-limit-fallback-redirect-url |
Ingress | Higress uzantısı (V1.2.25+) | — | Genel eşzamanlılık |
nginx.ingress.kubernetes.io/backend-protocol |
Service | Kısmen uyumlu | HTTP |
Arka uç protokolü |
nginx.ingress.kubernetes.io/load-balance |
Service | Kısmen uyumlu | round_robin |
Yük dengeleme |
nginx.ingress.kubernetes.io/upstream-hash-by |
Service | Kısmen uyumlu | — | Yük dengeleme |
higress.ingress.kubernetes.io/warmup |
Service | Higress uzantısı | Devre dışı | Isınma |
nginx.ingress.kubernetes.io/affinity |
Service | Uyumlu | cookie |
Çerez benzeşimi |
nginx.ingress.kubernetes.io/affinity-mode |
Service | Kısmen uyumlu | balanced |
Çerez benzeşimi |
nginx.ingress.kubernetes.io/session-cookie-name |
Service | Uyumlu | — | Çerez benzeşimi |
nginx.ingress.kubernetes.io/session-cookie-path |
Service | Uyumlu | / |
Çerez benzeşimi |
nginx.ingress.kubernetes.io/session-cookie-max-age |
Service | Uyumlu | Oturum düzeyi | Çerez benzeşimi |
nginx.ingress.kubernetes.io/session-cookie-expires |
Service | Uyumlu | Oturum düzeyi | Çerez benzeşimi |
nginx.ingress.kubernetes.io/whitelist-source-range |
Ingress | Uyumlu | — | IP erişim kontrolü |
nginx.ingress.kubernetes.io/denylist-source-range |
Ingress | Uyumlu (V1.2.31+) | — | IP erişim kontrolü |
higress.ingress.kubernetes.io/blacklist-source-range |
Ingress | Higress uzantısı | — | IP erişim kontrolü |
higress.ingress.kubernetes.io/domain-whitelist-source-range |
Ingress | Higress uzantısı | — | IP erişim kontrolü |
higress.ingress.kubernetes.io/domain-blacklist-source-range |
Ingress | Higress uzantısı | — | IP erişim kontrolü |
higress.ingress.kubernetes.io/connection-policy-tcp-max-connection |
Service | Higress uzantısı | — | Bağlantı havuzu |
higress.ingress.kubernetes.io/connection-policy-tcp-max-connection-per-endpoint |
Service | Higress uzantısı | — | Bağlantı havuzu |
higress.ingress.kubernetes.io/connection-policy-http-max-request-per-connection |
Service | Higress uzantısı | — | Bağlantı havuzu |
higress.ingress.kubernetes.io/tls-min-protocol-version |
Etki alanı adı | Higress uzantısı | TLSv1.0 |
İstemci-ağ geçidi TLS |
higress.ingress.kubernetes.io/tls-max-protocol-version |
Etki alanı adı | Higress uzantısı | TLSv1.3 |
İstemci-ağ geçidi TLS |
nginx.ingress.kubernetes.io/ssl-cipher |
Etki alanı adı | Uyumlu | Açıklamaya bakın | İstemci-ağ geçidi TLS |
higress.ingress.kubernetes.io/auth-tls-secret |
Etki alanı adı | Kısmen uyumlu | — | İstemci-ağ geçidi TLS |
nginx.ingress.kubernetes.io/proxy-ssl-secret |
Service | Uyumlu | — | Ağ geçidi-arka uç TLS |
nginx.ingress.kubernetes.io/proxy-ssl-name |
Service | Uyumlu | — | Ağ geçidi-arka uç TLS |
nginx.ingress.kubernetes.io/proxy-ssl-server-name |
Service | Uyumlu | — | Ağ geçidi-arka uç TLS |
nginx.ingress.kubernetes.io/auth-type |
Ingress | Kısmen uyumlu | — | Temel kimlik doğrulama |
nginx.ingress.kubernetes.io/auth-secret |
Ingress | Uyumlu | — | Temel kimlik doğrulama |
nginx.ingress.kubernetes.io/auth-secret-type |
Ingress | Uyumlu | — | Temel kimlik doğrulama |
nginx.ingress.kubernetes.io/auth-realm |
Ingress | Uyumlu | — | Temel kimlik doğrulama |
Kapsam
Her ek açıklama tek bir kapsam için geçerlidir:
Ingress — Ek açıklamanın ayarlandığı Ingress kaynağındaki yönlendirme kuralları için geçerlidir.
Etki alanı adı — Aynı ana bilgisayar adlarını (hosts) paylaşan tüm Ingress kaynakları için geçerlidir.
Service — Aynı hizmetleri paylaşan tüm Ingress kaynakları için geçerlidir.
Ek açıklama önekleri
NGINX Ingress ve APIG Ingress arasında paylaşılan ek açıklamalar için aşağıdaki önekler birbirinin yerine kullanılabilir:
nginx.ingress.kubernetes.io/xxxhigress.ingress.kubernetes.io/xxx
Higress extension olarak işaretlenen ek açıklamalar higress öneki gerektirir ve nginx öneki kullanılamaz.
Uyumluluk notları
NGINX Ingress'ten temel farklar şunlardır:
NGINX değişkenleri: Ek açıklamalardaki ve kod parçacıklarındaki NGINX değişkenleri APIG Ingress ile uyumlu değildir. Değişkene bağlı ek açıklamaları geçişten önce gözden geçirin.
İstek gövdesi boyutu: NGINX Ingress, zorunlu bir sınırı uygulamak için
nginx.ingress.kubernetes.io/proxy-body-sizekullanır ve sınır aşıldığında hata döndürür. APIG Ingress, önceden tanımlanmış gövde boyutu sınırı olmadan blok tabanlı akış kullanır. Ultra büyük dosya aktarımları için ağ geçidi örnek yapılandırmasındaDownstreamConnectionBufferLimitsdeğerini ayarlayın.
Trafik yönetimi ek açıklamaları
Canary sürümü
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/canary |
Ingress | Uyumlu | Bir rota için canary sürümünü etkinleştirir veya devre dışı bırakır. |
nginx.ingress.kubernetes.io/canary-by-header |
Ingress | Uyumlu | Trafik bölme için kullanılan istek üst bilgisi anahtarı. |
nginx.ingress.kubernetes.io/canary-by-header-value |
Ingress | Uyumlu | Trafik bölme için istek üst bilgisi değeri. Tam eşleşmeyi destekler. |
nginx.ingress.kubernetes.io/canary-by-header-pattern |
Ingress | Uyumlu | Trafik bölme için istek üst bilgisi değeri. Regex eşleşmesini destekler. |
higress.ingress.kubernetes.io/canary-by-query |
Ingress | Higress uzantısı | Trafik bölme için kullanılan URL sorgu parametresi anahtarı. |
higress.ingress.kubernetes.io/canary-by-query-value |
Ingress | Higress uzantısı | Trafik bölme için URL sorgu parametresi değeri. Tam eşleşmeyi destekler. |
higress.ingress.kubernetes.io/canary-by-query-pattern |
Ingress | Higress uzantısı | Trafik bölme için URL sorgu parametresi değeri. Regex eşleşmesini destekler. |
nginx.ingress.kubernetes.io/canary-by-cookie |
Ingress | Uyumlu | Trafik bölme için kullanılan çerez anahtarı. |
higress.ingress.kubernetes.io/canary-by-cookie-value |
Ingress | Higress uzantısı (V1.2.30+) | Trafik bölme için çerez değeri. Tam eşleşmeyi destekler. |
nginx.ingress.kubernetes.io/canary-weight |
Ingress | Uyumlu | Trafik bölme için kullanılan hizmet ağırlığı. |
nginx.ingress.kubernetes.io/canary-weight-total |
Ingress | Uyumlu | Trafik bölme için toplam ağırlık. |
Çok hizmetli yönlendirme
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
higress.ingress.kubernetes.io/destination |
Ingress | Higress uzantısı | Trafiği ağırlığa göre birden çok hizmet arasında dağıtır. Söz dizimi: {weight}% {serviceName}.{serviceNamespace}.svc.cluster.local:{port} |
Bu ek açıklamayı ayarlamak, Ingress üzerindeki tüm yönlendirme kurallarının hedefini değiştirir. Söz dizimi geçersizse ek açıklama yok sayılır ve yönlendirme değişmez.
Örnek:
annotations:
# 60% of traffic goes to foo, 40% to bar
higress.ingress.kubernetes.io/destination: |
60% foo.default.svc.cluster.local:8080
40% bar.default.svc.cluster.local:9090
Hizmet alt kümeleri
Bir hizmet birden çok Dağıtımı (Deployment) yönettiğinde istekleri belirli bir Pod alt kümesine yönlendirin.
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
higress.ingress.kubernetes.io/service-subset |
Ingress | Higress uzantısı (V1.2.25+) | İsteklerin yönlendirileceği Pod alt kümesini tanımlar. |
higress.ingress.kubernetes.io/subset-labels |
Ingress | Higress uzantısı (V1.2.25+) | (İsteğe bağlı) Pod'ları alt kümelere sınıflandırmak için service-subset ile birlikte kullanılan etiket seçici. |
service-subset için yönlendirme davranışı:
-
subset-labelsayarlanmamışsa:""veyabaseolarak ayarlanırsa —opensergo.io/canary: ""etiketine sahip Pod'lara veya herhangi biropensergo.io/canaryetiket anahtarı olmayan Pod'lara yönlendirir.Başka bir değere (örneğin
gray) ayarlanırsa —opensergo.io/canary-gray: grayetiketine sahip Pod'lara yönlendirir.
subset-labelsayarlanmışsa — yalnızcasubset-labelsiçinde tanımlanan anahtar-değer çiftleriyle eşleşen etiketlere sahip Pod'lara yönlendirir.
Belirtilen etiketle eşleşen hiçbir Pod yoksa istekler otomatik olarak hizmetteki tüm Pod'lara iletilir.
Örnek:
annotations:
# Route to the "gray" subset of Pods
higress.ingress.kubernetes.io/service-subset: "gray"
Geri dönüş
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/default-backend |
Ingress | Uyumlu | Sağlıklı birincil düğümler olmadığında geri dönüş hizmeti. |
nginx.ingress.kubernetes.io/custom-http-errors |
Ingress | Uyumlu | Geri dönüş hizmetine iletmeyi tetikleyen HTTP durum kodları. |
Bir istek geri dönüş hizmetine iletildiğinde istek yolu / olarak yeniden yazılır. Bu, NGINX Ingress'in davranışıyla eşleşir.
Düzenli ifade eşleşmesi
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/use-regex |
Ingress | Uyumlu | Ingress üzerinde RE2 söz dizimini kullanarak regex yol eşleşmesini etkinleştirir. |
Yeniden yazma
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/rewrite-target |
Ingress | Uyumlu | URL yeniden yazma için hedef yol. Yakalama grupları desteklenir. |
nginx.ingress.kubernetes.io/upstream-vhost |
Ingress | Uyumlu | Arka uç hizmetine iletilen isteklerdeki Host üst bilgisini yeniden yazar. |
Yönlendirme
Yönlendirme için NGINX değişkenlerinin kullanılması NGINX Ingress belgelerinde yer almaz ve uyumluluk sorunlarına neden olabilir. Yönlendirme ek açıklamalarında NGINX değişkenlerinden kaçının.
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/ssl-redirect |
Ingress | Uyumlu | HTTP'den HTTPS'ye yönlendirir. |
nginx.ingress.kubernetes.io/force-ssl-redirect |
Ingress | Uyumlu | HTTP'den HTTPS'ye zorla yönlendirir. |
nginx.ingress.kubernetes.io/permanent-redirect |
Ingress | Uyumlu | Belirtilen URL'ye kalıcı yönlendirme gönderir. |
nginx.ingress.kubernetes.io/permanent-redirect-code |
Ingress | Uyumlu | Kalıcı yönlendirmeler için kullanılan HTTP durum kodu. |
nginx.ingress.kubernetes.io/temporal-redirect |
Ingress | Uyumlu | Belirtilen URL'ye geçici yönlendirme gönderir. |
nginx.ingress.kubernetes.io/app-root |
Ingress | Uyumlu | İstekleri / konumundan belirtilen uygulama kök yoluna yönlendirir. |
CORS
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/enable-cors |
Ingress | Uyumlu | Kaynaklar arası kaynak paylaşımını (CORS) etkinleştirir. |
nginx.ingress.kubernetes.io/cors-allow-origin |
Ingress | Uyumlu | CORS istekleri için izin verilen kaynaklar. |
nginx.ingress.kubernetes.io/cors-allow-methods |
Ingress | Uyumlu | CORS için izin verilen HTTP yöntemleri. GET, POST ve PUT içerir. |
nginx.ingress.kubernetes.io/cors-allow-headers |
Ingress | Uyumlu | CORS için izin verilen istek üst bilgileri. |
nginx.ingress.kubernetes.io/cors-expose-headers |
Ingress | Uyumlu | Tarayıcılara sunulan yanıt üst bilgileri. |
nginx.ingress.kubernetes.io/cors-allow-credentials |
Ingress | Uyumlu | Kimlik bilgilerinin CORS isteklerine dahil edilip edilemeyeceği. |
nginx.ingress.kubernetes.io/cors-max-age |
Ingress | Uyumlu | Ön uçuş sonuçlarının saniye cinsinden ne kadar süre önbelleğe alındığı. |
Üst bilgi kontrolü
Temel ve canary rotalarındaki üst bilgi kontrolü ek açıklamaları bağımsızdır ve ayrı ayrı doğrulanır. Her trafik türü için ayrı üst bilgi ilkeleri yapılandırmak üzere bunları kullanın.
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
higress.ingress.kubernetes.io/request-header-control-add |
Ingress | Higress uzantısı | İletilen isteklere bir üst bilgi ekler. Üst bilgi zaten varsa değer eklenir. |
higress.ingress.kubernetes.io/request-header-control-update |
Ingress | Higress uzantısı | İletilen isteklerdeki bir üst bilginin üzerine yazar. |
higress.ingress.kubernetes.io/request-header-control-remove |
Ingress | Higress uzantısı | İletilen isteklerden bir üst bilgiyi kaldırır. |
higress.ingress.kubernetes.io/response-header-control-add |
Ingress | Higress uzantısı | İstemci yanıtlarına bir üst bilgi ekler. Üst bilgi zaten varsa değer eklenir. |
higress.ingress.kubernetes.io/response-header-control-update |
Ingress | Higress uzantısı | İstemci yanıtlarındaki bir üst bilginin üzerine yazar. |
higress.ingress.kubernetes.io/response-header-control-remove |
Ingress | Higress uzantısı | İstemci yanıtlarından bir üst bilgiyi kaldırır. |
Söz dizimi:
Tek üst bilgi (ekleme/güncelleme): Bir anahtar-değer çifti kullanın. Örnek:
X-Custom-Header: valueBirden çok üst bilgi (ekleme/güncelleme): YAML blok skaleri (
|) kullanın. Her satıra bir anahtar-değer çifti yazın.Tek üst bilgi (kaldırma): Yalnızca üst bilgi anahtarını kullanın.
Birden çok üst bilgi (kaldırma): Virgülle ayrılmış üst bilgi anahtarları.
Örnek — bir istek üst bilgisi ekleme:
annotations:
higress.ingress.kubernetes.io/request-header-control-add: "X-Request-Id: abc123"
Örnek — birden çok yanıt üst bilgisi ekleme:
annotations:
higress.ingress.kubernetes.io/response-header-control-add: |
X-Custom-Header: value1
X-Another-Header: value2
Örnek — birden çok istek üst bilgisini kaldırma:
annotations:
higress.ingress.kubernetes.io/request-header-control-remove: "X-Forwarded-For,X-Real-IP"
Zaman aşımı
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
higress.ingress.kubernetes.io/timeout |
Ingress | Higress uzantısı | Yok | Saniye cinsinden istek zaman aşımı. |
Bu zaman aşımı TCP taşıma katmanında değil, uygulama katmanında (HTTP) geçerlidir.
Yeniden deneme
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
nginx.ingress.kubernetes.io/proxy-next-upstream-tries |
Ingress | Uyumlu | 3 |
Maksimum yeniden deneme sayısı. |
nginx.ingress.kubernetes.io/proxy-next-upstream-timeout |
Ingress | Uyumlu | Yok | Saniye cinsinden yeniden denemeler için zaman aşımı. |
nginx.ingress.kubernetes.io/proxy-next-upstream |
Ingress | Uyumlu | — | Yeniden deneme koşulları. Geçerli değerler için NGINX yeniden deneme mekanizmasına bakın. |
Trafik yansıtma
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
higress.ingress.kubernetes.io/mirror-target-service |
Ingress | Higress uzantısı | — | Yansıtılan trafik için hedef hizmet. Biçim: namespace/name:port. namespace varsayılan olarak Ingress ağ geçidi ad alanıdır; port varsayılan olarak ilk bağlantı noktasıdır. name gereklidir. |
higress.ingress.kubernetes.io/mirror-percentage |
Ingress | Higress uzantısı (V1.2.32+) | 100 |
Yansıtılacak trafik yüzdesi. Geçerli değerler: 0–100. |
Örnek:
annotations:
# Mirror 20% of traffic to the shadow service
higress.ingress.kubernetes.io/mirror-target-service: "default/shadow-service:8080"
higress.ingress.kubernetes.io/mirror-percentage: "20"
Etki alanı takma adı
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/server-alias |
Etki alanı adı | Kısmen uyumlu (V1.2.30+) | Birincil etki alanının TLS, yönlendirme ve trafik yönetimi yapılandırmasını paylaşan takma ad etki alanı. Yalnızca tam eşleşmeli ve joker karakterli etki alanlarını destekler. |
Hız sınırlama (kullanımdan kaldırıldı)
Bu ek açıklamalar kullanımdan kaldırılmıştır. Bunun yerine genel kısıtlama kontrolünü kullanın.
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
higress.ingress.kubernetes.io/route-limit-rpm |
Ingress | Higress uzantısı | — | Ağ geçidi başına dakika başına maksimum istek sayısı (RPM). Patlama limiti = değer × route-limit-burst-multiplier. Tetiklendiğinde yanıt gövdesi local_rate_limited olur. V1.2.23 öncesinde 503, V1.2.23 ve sonrasında 429 döndürür. |
higress.ingress.kubernetes.io/route-limit-rps |
Ingress | Higress uzantısı | — | Ağ geçidi başına saniye başına maksimum istek sayısı (RPS). Patlama ve yanıt davranışı route-limit-rpm ile aynıdır. |
higress.ingress.kubernetes.io/route-limit-burst-multiplier |
Ingress | Higress uzantısı | 5 |
Patlama limiti çarpanı. |
Genel kısıtlama kontrolü (önerilen)
Bu bölümdeki tüm ek açıklamalar ağ geçidi sürümü V1.2.25 veya sonraki bir sürümü gerektirir.
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
higress.ingress.kubernetes.io/rate-limit |
Ingress | Higress uzantısı | — | Rota için maksimum RPS. Genel hız sınırlama için kullanılır. |
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-code |
Ingress | Higress uzantısı | 429 |
Hız sınırlama tetiklendiğinde HTTP yanıt kodu. |
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body-type |
Ingress | Higress uzantısı | text |
Hız sınırlama tetiklendiğinde yanıt gövdesi içerik türü. application/json; charset=UTF-8 döndürmek için json olarak ayarlayın. |
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body |
Ingress | Higress uzantısı | sentinel rate limited |
Hız sınırlama tetiklendiğinde yanıt gövdesi. |
higress.ingress.kubernetes.io/rate-limit-fallback-redirect-url |
Ingress | Higress uzantısı | — | Hız sınırlama tetiklendiğinde yönlendirme URL'si. |
rate-limit-fallback-custom-response-codeverate-limit-fallback-redirect-urlbirbirini dışlar. Yalnızca birini ayarlayın.
Örnek — hız sınırlama tetiklendiğinde özel JSON yanıtı döndürme:
annotations:
higress.ingress.kubernetes.io/rate-limit: "100"
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-code: "429"
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body-type: "json"
higress.ingress.kubernetes.io/rate-limit-fallback-custom-response-body: '{"error":"rate limit exceeded"}'
Genel eşzamanlılık kontrolü
Bu bölümdeki tüm ek açıklamalar ağ geçidi sürümü V1.2.25 veya sonraki bir sürümü gerektirir.
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
higress.ingress.kubernetes.io/concurrency-limit |
Ingress | Higress uzantısı | — | Rotadaki maksimum eşzamanlı istek sayısı. |
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-code |
Ingress | Higress uzantısı | 429 |
Eşzamanlılık kontrolü tetiklendiğinde HTTP yanıt kodu. |
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body-type |
Ingress | Higress uzantısı | text |
Eşzamanlılık kontrolü tetiklendiğinde yanıt gövdesi içerik türü. application/json; charset=UTF-8 döndürmek için json olarak ayarlayın. |
higress.ingress.kubernetes.io/concurrency-limit-fallback-custom-response-body |
Ingress | Higress uzantısı | sentinel rate limited |
Eşzamanlılık kontrolü tetiklendiğinde yanıt gövdesi. |
higress.ingress.kubernetes.io/concurrency-limit-fallback-redirect-url |
Ingress | Higress uzantısı | — | Eşzamanlılık kontrolü tetiklendiğinde yönlendirme URL'si. |
concurrency-limit-fallback-custom-response-codeveconcurrency-limit-fallback-redirect-urlbirbirini dışlar. Yalnızca birini ayarlayın.
Arka uç protokolü
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
nginx.ingress.kubernetes.io/backend-protocol |
Service | Kısmen uyumlu | HTTP |
Arka uç hizmeti tarafından kullanılan protokol. AJP ve FCGI desteklenmez. Geçerli değerler: HTTP, HTTP2, HTTPS, gRPC, gRPCS. |
Yük dengeleme
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
nginx.ingress.kubernetes.io/load-balance |
Service | Kısmen uyumlu | round_robin |
Yük dengeleme algoritması. Üstel Ağırlıklı Hareketli Ortalama (EWMA) desteklenmez; round_robin değerine geri döner. Geçerli değerler: round_robin, least_conn, random. |
nginx.ingress.kubernetes.io/upstream-hash-by |
Service | Kısmen uyumlu | — | Tutarlı karma algoritması. NGINX değişkenlerinin sabitlerle birleştirilmesi desteklenmez. NGINX değişkenine ($request_uri, $host, $remote_addr), istek üst bilgisine ($http_headerName) veya sorgu parametresine ($arg_varName) göre karma oluşturmayı destekler. |
Isınma (yumuşak başlatma)
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
higress.ingress.kubernetes.io/warmup |
Service | Higress uzantısı | Devre dışı | Saniye cinsinden ısınma süresi. |
Isınma, round_robin veya least_conn yük dengeleme algoritması gerektirir. Diğer algoritmalarla desteklenmez.
Çerez benzeşimi
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
nginx.ingress.kubernetes.io/affinity |
Service | Uyumlu | cookie |
Benzeşim türü. Varsayılan ve tek geçerli değer: cookie. |
nginx.ingress.kubernetes.io/affinity-mode |
Service | Kısmen uyumlu | balanced |
Benzeşim modu. persistent modu desteklenmez. Varsayılan ve tek geçerli değer: balanced. |
nginx.ingress.kubernetes.io/session-cookie-name |
Service | Uyumlu | — | Karma anahtarı olarak kullanılan çerezin adı. |
nginx.ingress.kubernetes.io/session-cookie-path |
Service | Uyumlu | / |
Belirtilen çerez olmadığında oluşturulan çerezin yolu. |
nginx.ingress.kubernetes.io/session-cookie-max-age |
Service | Uyumlu | Oturum düzeyi | Oluşturulan çerezin saniye cinsinden sona erme süresi. |
nginx.ingress.kubernetes.io/session-cookie-expires |
Service | Uyumlu | Oturum düzeyi | Oluşturulan çerezin saniye cinsinden sona erme süresi. |
IP adresi erişim kontrolü
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/whitelist-source-range |
Ingress | Uyumlu | Rota için IP adresleri ve CIDR bloklarının izin listesi. Virgülle ayrılır. |
nginx.ingress.kubernetes.io/denylist-source-range |
Ingress | Uyumlu (V1.2.31+) | Rota düzeyinde IP adresleri ve CIDR bloklarının engelleme listesi. Virgülle ayrılır. higress.ingress.kubernetes.io/blacklist-source-range değerine göre önceliklidir. |
higress.ingress.kubernetes.io/blacklist-source-range |
Ingress | Higress uzantısı | Rota için IP adresleri ve CIDR bloklarının engelleme listesi. Virgülle ayrılır. |
higress.ingress.kubernetes.io/domain-whitelist-source-range |
Ingress | Higress uzantısı | Etki alanı düzeyinde IP adresleri ve CIDR bloklarının izin listesi. Virgülle ayrılır. Rota düzeyindeki izin listeleri önceliklidir. |
higress.ingress.kubernetes.io/domain-blacklist-source-range |
Ingress | Higress uzantısı | Etki alanı düzeyinde IP adresleri ve CIDR bloklarının engelleme listesi. Virgülle ayrılır. Rota düzeyindeki engelleme listeleri önceliklidir. |
Bağlantı havuzu (ağ geçidinden arka uca)
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
higress.ingress.kubernetes.io/connection-policy-tcp-max-connection |
Service | Higress uzantısı | Arka uç hizmetine yönelik toplam maksimum TCP bağlantısı. |
higress.ingress.kubernetes.io/connection-policy-tcp-max-connection-per-endpoint |
Service | Higress uzantısı | Arka uç uç noktası başına maksimum TCP bağlantısı. |
higress.ingress.kubernetes.io/connection-policy-http-max-request-per-connection |
Service | Higress uzantısı | Arka uç bağlantısı başına maksimum HTTP isteği. |
Güvenlik ek açıklamaları
İstemci-ağ geçidi TLS
| Ek Açıklama | Kapsam | Durum | Varsayılan | Açıklama |
|---|---|---|---|---|
higress.ingress.kubernetes.io/tls-min-protocol-version |
Etki alanı adı | Higress uzantısı | TLSv1.0 |
Minimum TLS sürümü. Geçerli değerler: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. |
higress.ingress.kubernetes.io/tls-max-protocol-version |
Etki alanı adı | Higress uzantısı | TLSv1.3 |
Maksimum TLS sürümü. Geçerli değerler: TLSv1.0, TLSv1.1, TLSv1.2, TLSv1.3. |
nginx.ingress.kubernetes.io/ssl-cipher |
Etki alanı adı | Uyumlu | Aşağıya bakın | TLS şifre paketleri, virgülle ayrılır. Yalnızca TLS v1.0–v1.2 için geçerlidir (v1.3 için değil). |
higress.ingress.kubernetes.io/auth-tls-secret |
Etki alanı adı | Kısmen uyumlu | — | mTLS istemci doğrulaması için CA sertifikası. Gizli dizi adı biçimi: {domain-certificate-secret-name}-cacert. |
ssl-cipher için varsayılan şifre paketleri: 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.
Ağ geçidi-arka uç TLS
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/proxy-ssl-secret |
Service | Uyumlu | Arka uç kimlik doğrulaması için ağ geçidi tarafından kullanılan istemci sertifikası. |
nginx.ingress.kubernetes.io/proxy-ssl-name |
Service | Uyumlu | Arka uçla yapılan TLS el sıkışması sırasında gönderilen Sunucu Adı Göstergesi (SNI). |
nginx.ingress.kubernetes.io/proxy-ssl-server-name |
Service | Uyumlu | Arka uçla yapılan TLS el sıkışması sırasında SNI'yi etkinleştirir veya devre dışı bırakır. |
Temel kimlik doğrulama
| Ek Açıklama | Kapsam | Durum | Açıklama |
|---|---|---|---|
nginx.ingress.kubernetes.io/auth-type |
Ingress | Kısmen uyumlu | Kimlik doğrulama türü. Yalnızca basic desteklenir. |
nginx.ingress.kubernetes.io/auth-secret |
Ingress | Uyumlu | Rota için kimlik bilgilerini içeren gizli dizi. Biçim: <namespace>/<name>. |
nginx.ingress.kubernetes.io/auth-secret-type |
Ingress | Uyumlu | Gizli dizi verilerinin biçimi. auth-file: anahtar auth, değer username:password (satır başına bir giriş). auth-map: anahtar kullanıcı adı, değer şifredir. |
nginx.ingress.kubernetes.io/auth-realm |
Ingress | Uyumlu | Kimlik doğrulama alanı. Kimlik bilgileri bir alan içinde paylaşılır. |
Tam NGINX Ingress ek açıklama referansı: Ek Açıklamalar.