ApigConfig, APIG Controller tarafından sağlanan ve APIG ağ geçidi örneklerinin yaşam döngüsünü yönetmek, Ingress dinleyici seçeneklerini yapılandırmak ve IP erişim kontrolü, günlük toplama ile izleme gibi genel ayarları tanımlamak için kullanılan bir CRD'dir.
ApigConfig'a Genel Bakış
Yapılandırma
ApigConfig, APIG Controller tarafından sunulan ve APIG ağ geçidi örneklerinin yaşam döngüsü ile genel yapılandırmalarını yönetmek için kullanılan bir CRD'dir.
Her bir ApigConfig kaynağı tek bir APIG ağ geçidi örneğine karşılık gelir. Birden fazla APIG ağ geçidi örneği kullanmak istiyorsanız birden fazla ApigConfig kaynağı oluşturmanız gerekir.
Yeniden kullanım senaryoları hariç , bir ApigConfig kaydının silinmesi buna bağlı olan APIG ağ geçidi örneğini de siler.
CRD (ApigConfig) kullanılarak oluşturulan bir APIG ağ geçidi örneğinde; API'ler, rotalar ve sertifikalar gibi iş yapılandırmalarını CRD üzerinden yönetin. Ölçeklendirme gibi işlemler için APIG konsolunu kullanabilirsiniz. Konsolda, CRD ile oluşturulmuş bir örneğin iş yapılandırmalarını değiştirmeyin; çünkü CRD senkronizasyonu yaptığınız değişikliklerin üzerine yazarak yapılandırma çakışmalarına neden olabilir.
Aşağıda eksiksiz bir ApigConfig yapılandırma örneği verilmiştir.
apiVersion: apig.alibabacloud.com/v1alpha1
kind: ApigConfig
metadata:
name: apig-ingress
spec:
name: apig-ingress
common:
pay:
payType: POSTPAY
instance:
spec: apigw.small.x1
network:
vSwitches:
- "vsw-1"
- "vsw-2"
networkType: Internet
securityGroupType: enterprise
global:
tls:
enableHardwareAcceleration: true
ipAccessControl:
whitelist:
- 1.1.XX.XX
- 2.2.XX.XX
monitor:
logging:
sls:
reuseProject: "xxx" # Leave blank to use the default project.
tracing:
openTelemetry:
sampleRate: "100"
ingress:
local:
ingressClass: apig
watchNamespace: "" # An empty string ("") indicates Ingress resources in all namespaces.
|
Parametre |
Açıklama |
Varsayılan |
|
|
Ağ geçidi adı. |
apig-ingress |
|
|
Faturalandırma yöntemi. Yalnızca kullandıkça öde desteklenir ve belirtilmediğinde varsayılan olarak bu yöntem seçilir. |
POSTPAY |
|
|
Ağ geçidi örneği türü. Geçerli değerler:
|
apigw.small.x1 |
|
|
Birincil ve yedek vSwitch'ler (bu sırayla). Bir veya iki vSwitch belirtin. Belirtilmezse vSwitch'ler, APIG Controller pod'unun çalıştığı düğümden devralınır. |
Yok |
|
|
Ağ geçidinin ağ erişilebilirliği. Geçerli değerler:
|
Internet |
|
|
Güvenlik grubu türü. Geçerli değerler:
|
normal |
|
|
TLS donanım hızlandırmanın etkinleştirilip etkinleştirilmeyeceğini belirtir. Bu özellik HTTPS trafiği performansını önemli ölçüde artırabilir. |
Etkin |
|
|
Genel IP izin listesi. |
Yapılandırılmamış |
|
|
Genel IP engelleme listesi. |
Yapılandırılmamış |
|
|
Simple Log Service (SLS) günlük toplamayı etkinleştirip etkinleştirmeyeceğinizi belirtir. Bu özelliği etkinleştirmek için APIG Controller'a gerekli SLS izinlerini vermeniz gerekir. |
Devre dışı |
|
|
Erişim günlüklerinin saklanacağı SLS projesi. Geçerli değerler:
|
Boş |
|
|
Tracing Analysis (x-trace) için örnekleme oranı. |
0 |
|
|
OpenTelemetry izlemeyi etkinleştirir veya devre dışı bırakır. |
Varsayılan olarak devre dışıdır. |
|
|
OpenTelemetry izleme için örnekleme oranı. |
100 |
|
|
APIG ağ geçidi örneğinin hangi Ingress kaynaklarını işleyeceğini IngressClass'a göre belirler. Geçerli değerler:
Not
Bu ayarın önceliği, bir IngressClass aracılığıyla ApigConfig ilişkilendirmesine göre daha düşüktür. |
Yapılandırılmamış |
|
|
Ağ geçidinin Ingress kaynaklarını izlediği ad alanları. Geçerli değerler:
|
Boş |
Durum
Bir ApigConfig kaynağı oluşturduktan sonra durumunu kontrol etmek için kubectl get ApigConfig komutunu çalıştırın. Kaynak aşağıdaki durumlar arasında geçiş yapar: Pending > Running > Listening.
Pending: APIG ağ geçidi örneği oluşturuluyor. Bu işlem yaklaşık 3 dakika sürer.Running: APIG ağ geçidi örneği oluşturuldu ve çalışıyor.Listening: APIG ağ geçidi örneği çalışıyor ve kümedeki Ingress kaynaklarını dinliyor.Failed: APIG ağ geçidi örneği geçersiz durumda. Nedenini öğrenmek içinStatusalanındakiMessagebilgisini kontrol edin.
Etiketler
ApigConfig aracılığıyla oluşturulan veya yeniden kullanılan APIG ağ geçidi örneklerine kaynak etiketleri eklenir. Etiket bilgilerini APIG konsolu içindeki Temel Bilgiler bölümünde görüntüleyebilirsiniz.
Bu etiketleri APIG konsolunda düzenlemeyin; aksi takdirde ağ geçidi örneğiniz bozulabilir.
|
|
|
|
|
|
|
|
|
|
|
|
APIG Ağ Geçidi Örneği Oluşturma
-
ApigConfig'i yapılandırın.
Aşağıdaki örnek, apigw.small.x1 teknik özelliklerine sahip apig-ingress adlı bir APIG ağ geçidi örneği oluşturur. Diğer ApigConfig ayarlarını ihtiyacınıza göre değiştirin.
apiVersion: apig.alibabacloud.com/v1alpha1 kind: ApigConfig metadata: name: apig-ingress spec: name: apig-ingress common: instance: spec: apigw.small.x1 -
Container Service for Kubernetes (ACK) kümenizde bir IngressClass oluşturun ve spec.parameters kullanarak bunu ApigConfig ile ilişkilendirin. Bu işlem kümede bir Ingress işlemcisi bildirir.
Yapılandırma tamamlandığında, bağlantılı APIG ağ geçidi örneği bu IngressClass ile ilişkili tüm Ingress kaynaklarını işler.
apiVersion: networking.k8s.io/v1 kind: IngressClass metadata: name: apig spec: controller: apig.alibabacloud.com/ingress parameters: apiGroup: apig.alibabacloud.com kind: ApigConfig name: apig-ingress
Var Olan Bir APIG Ağ Geçidi Örneğini Yeniden Kullanma
Var olan bir APIG ağ geçidi örneğini yeniden kullanmak için ApigConfig'inizin spec.id alanına örnek ID'sini (örneğin gw-xxx) girin. ApigConfig ayarlarının var olan örnek yapılandırmasının üzerine yazıp yazmayacağını denetlemek için spec.override parametresini kullanın.
Aşağıdaki örnek var olan bir APIG ağ geçidi örneğini yeniden kullanır. ApigConfig, örneği bir kümeyle ilişkilendirir ve apig IngressClass'a sahip Ingress kaynaklarını işlemek üzere yapılandırır.
Aşağıdaki yapılandırmada
spec.overridedeğerifalseolarak ayarlanmıştır; bu, var olan bir APIG ağ geçidinin Ingress dinleyici seçenekleri ve genel yapılandırmasının üzerine yazılmayacağı anlamına gelir. Var olan bir ağ geçidi örneği konteyner kümesiyle ilişkilendirilmemişse otomatik olarak kümeyle ilişkilendirilir ve Ingress dinleyici seçenekleri,ingressClassdeğerispec.ingress.local.ingressClass(bu örnekteapig) olan Ingress kaynaklarını dinleyecek şekilde yapılandırılır. Ağ geçidi örneği zaten konteyner kümesiyle ilişkilendirilmişse var olan Ingress dinleyici seçenekleri değiştirilmez.Var olan bir APIG ağ geçidinin Ingress dinleyici seçenekleri ve genel yapılandırmalarının üzerine yazmak istiyorsanız
spec.overrideözelliğini etkinleştirmeden önce ApigConfig içindeki ağ geçidi parametrelerinin (Ingress dinleyici seçenekleri, donanım hızlandırma, genel IP adresi engelleme ve izin listeleri ile gözlemlenebilirlik) doğru yapılandırıldığından emin olun. Bu yapılandırmalar ApigConfig'de belirtilmemişsespec.overrideetkinleştirildiğinde orijinal ağ geçidi parametreleri (Ingress dinleyici seçenekleri, donanım hızlandırma, genel IP adresi engelleme ve izin listeleri ile gözlemlenebilirlik) üzerine yazılır ve bu durum trafiği etkileyebilir.
apiVersion: apig.alibabacloud.com/v1alpha1
kind: ApigConfig
metadata:
name: reuse
spec:
id: gw-xxxx
override: false
ingress:
local:
ingressClass: apig
|
Parametre |
Açıklama |
|
|
Yeniden kullanılacak hedef APIG ağ geçidi örneğinin ID'si. ID |
|
|
Yeniden kullanılan APIG ağ geçidi örneği yapılandırmalarının ApigConfig ayarlarına göre üzerine yazılıp yazılmayacağını belirtir.
|
APIG Ağ Geçidi Örneğini Silme
Yeniden kullanılan örnekler hariç, bir ApigConfig silindiğinde buna bağlı APIG ağ geçidi örneği de silinir.
Aşağıdaki tabloda silme ilkesi açıklanmaktadır.
|
|
|
|
|
|
|
|
ApigConfig'i silmek için aşağıdaki komutu çalıştırın:
kubectl delete ApigConfig your-config-name
Genel IP Erişim Kontrolünü Yapılandırma
IP İzin Listesi Yapılandırma
APIG Ingress'e yalnızca belirli kaynak IP'lerden erişime izin vermek için genel bir IP izin listesi yapılandırın.
Aşağıdaki örnek yalnızca 1.1.XX.XX kaynak IP'sinden ve 2.0.XX.XX/8 CIDR bloğundan gelen erişime izin verir.
apiVersion: apig.alibabacloud.com/v1alpha1
kind: ApigConfig
metadata:
name: apig-ingress
spec:
...
global:
ipAccessControl:
whitelist:
- 1.1.XX.XX
- 2.0.XX.XX/8
...
IP Engelleme Listesi Yapılandırma
Belirli kaynak IP'lerinden gelen erişimi reddetmek için genel, örnek düzeyinde bir IP engelleme listesi yapılandırın.
Aşağıdaki örnek 1.1.XX.XX kaynak IP'sinden ve 2.0.XX.XX/8 CIDR bloğundan gelen istekleri reddeder.
apiVersion: apig.alibabacloud.com/v1alpha1
kind: ApigConfig
metadata:
name: apig-ingress
spec:
...
global:
ipAccessControl:
blacklist:
- 1.1.XX.XX
- 2.0.XX.XX/8
...
SLS Günlük Toplamayı Etkinleştirme
Günlük toplamayı etkinleştirmeden önce APIG Controller'ın gerekli SLS izinlerine sahip olduğundan emin olun.
ACK yönetilen kümeler için bkz. APIG Controller'a İzin Verme .
Aşağıdaki örnek ağ geçidini, erişim günlüklerini demo adlı bir SLS projesine göndermek üzere yapılandırır.
apiVersion: apig.alibabacloud.com/v1alpha1
kind: ApigConfig
metadata:
name: apig-ingress
spec:
...
monitor:
logging:
sls:
# Configure reuseProject to enable Simple Log Service. If you want to use the default project, leave this field blank.
reuseProject: "demo"
...
OpenTelemetry İzlemeyi Etkinleştirme
Üretim sorunlarını teşhis etmek için uçtan uca bir izleme sistemi oluşturmak amacıyla ağ geçidi için OpenTelemetry izlemeyi yapılandırın.
Aşağıdaki örnek %100 örnekleme oranı (sampleRate) ile OpenTelemetry izlemeyi yapılandırır.
apiVersion: apig.alibabacloud.com/v1alpha1
kind: ApigConfig
metadata:
name: apig-ingress
spec:
...
monitor:
tracing:
openTelemetry:
sampleRate: "100"
...
Ek Yapılandırmalar
APIG Ingress ağ geçidi örneği aşağıdaki ek yapılandırmaları destekler:
Bu ayarları uygulamak için Cloud-native API Gateway konsoluna gidin. sayfasında ağ geçidi örneğini seçin ve ardından sol gezinme bölmesinde Parameter Settings öğesine tıklayın.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Tek bir bağlantının arabellek boyutu; bu değer aktarım hızını ve ağ geçidi bellek kullanımını etkiler. Geçerli aralık: [0, 2147483647]. |
|
|
|
Ağ geçidinin önündeki güvenilir proxy sunucusu sayısı. Bu değer, ağ geçidinin Değer aralığı: [0, 10]. Birim: öğe. |
|
|
|
İstemci HTTP/2 kullandığında tek bir bağlantıdaki eşzamanlı akışların maksimum sayısı. Değer aralığı: [0, 2147483647]. Birim: bayt. |
|
|
|
Ağ geçidi ile istemci arasında yapılan ilk HTTP/2 Değer aralığı: [65535, 2147483647]. Birim: bayt. |
|
|
|
Ağ geçidi ile istemci arasında yapılan ilk HTTP/2 bağlantı düzeyi pencere boyutu. Değer aralığı: [65535, 2147483647]. Birim: bayt. |
|
|
|
HTTP/3 protokolünün desteklenip desteklenmeyeceğini belirtir. HTTP/3, TLS donanım hızlandırma ile uyumlu değildir. HTTP/3'ü etkinleştirmeden önce donanım hızlandırmayı devre dışı bırakmanız gerekir. |
|
|
|
URI yollarında %2F, %2f, %5C veya %5c gibi kaçış karakterleri içeren istekler için yapılacak eylemi belirler. Varsayılan değer Geçerli değerler: |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
İstemciye döndürülen Değer aralığı: [0, 600]. Birim: saniye. |
|
|
|
Ağ geçidi yükseltmeler veya yeniden başlatmalar sırasında bağlantıları kapattığında aktif WebSocket bağlantıları için tanılama süresi. Değer aralığı: [20, 900]. Birim: saniye. |
|
|
|
|
|
|
|
|
SSS
Bir APIG Ingress'i sildikten ve yeniden oluşturduktan sonra uç nokta boş kalıyorsa ne yapmalıyım?
Bir Ingress'i silip aynı YAML dosyasını kullanarak yeniden oluşturursanız ancak bir süre beklemenize rağmen uç nokta hala boş kalıyorsa genellikle ApigConfig'de Ingress dinleyici seçenekleri yapılandırılmamıştır. Bu nedenle APIG ağ geçidi örneği Ingress kaynağını izlemez. Sorunu şu şekilde giderin:
ApigConfig'de
spec.ingress.local.ingressClassalanının yapılandırılıp yapılandırılmadığını kontrol edin. Bu alan yapılandırılmamışsa APIG ağ geçidi örneği hiçbir Ingress kaynağını izlemez ve Ingress'i yeniden oluşturduktan sonra uç nokta geri gelmez. Bu alanıapigolarak ayarlayın.Ingress'in IngressClass değerinin ApigConfig'deki
ingress.local.ingressClassdeğeriyle eşleştiğinden emin olun. Bir Ingress'in IngressClass değerinikubernetes.io/ingress.class: apigek açıklaması veyaspec.ingressClassNamealanı kullanarak belirtebilirsiniz.kubectl get apigconfigkomutunu çalıştırarak ApigConfig durumununListeningolup olmadığını kontrol edin.Önceki yapılandırmalar doğru olduktan sonra Ingress'i yeniden oluşturun. Uç nokta otomatik olarak geri gelir. APIG ağ geçidi örneğini yeniden oluşturmanıza gerek yoktur.