İşlem kılavuzu

Apigee Edge belgelerini görüntülüyorsunuz.
Apigee X belgelerine gidin. bilgi

API anahtarı edinme

Aşağıdaki örnekte, Apigee Adapter for Envoy üzerinden proxy'si oluşturulan bir hedef hizmete yönelik API çağrılarını doğrulamak için kullanabileceğiniz bir API anahtarının nasıl alınacağı açıklanmaktadır.

1. Apigee'ye giriş yapma

1. Apigee kullanıcı arayüzünü bir tarayıcıda açın.
2. Kullanıcı arayüzüne girdikten sonra, Apigee Adapter for Envoy'u yapılandırmak için kullandığınız kuruluşu seçin.

2. Geliştirici Oluşturma

Test için mevcut bir geliştiriciyi kullanabilir veya aşağıdaki şekilde yeni bir geliştirici oluşturabilirsiniz:

1. Yan gezinme menüsünde Yayınla > Geliştiriciler'i seçin.
2. + Geliştirici'yi tıklayın.
3. Yeni bir geliştirici oluşturmak için iletişim kutusunu doldurun. İstediğiniz geliştirici adını/e-posta adresini kullanabilirsiniz.

3. API Ürünü Oluşturma

Aşağıda verilen ürün oluşturma örneğini uygulayın. Ayrıca API ürün yapılandırması hakkında başlıklı makaleyi de inceleyin.

1. Yan gezinme menüsünde Yayınla > API Ürünleri'ni seçin.
2. + API Ürünü'nü tıklayın.
3. Ürün ayrıntıları sayfasını aşağıdaki şekilde doldurun. Talimat verilene kadar Kaydet'i tıklamayın.

Alan	Değer
Ad	httpbin-product
Görünen ad	httpbin product
Ortam	your_environment Bu değeri, apigee-remote-service-cli ile Apigee Adapter for Envoy'u sağlarken kullandığınız ortama ayarlayın.
Erişim	Private
Kota	1 dakika içinde 5 istek Ayrıca Kotaları anlama başlıklı makaleyi de inceleyin.

4. Apigee uzak hizmet hedefleri bölümünde Apigee uzak hizmet hedefi ekle'yi tıklayın.
5. Apigee uzak hizmet hedefi iletişim kutusuna aşağıdaki değerleri ekleyin:

   Özellik	Değer	Açıklama
   Hedef adı	Hedef hizmetin adını girin. Örneğin: httpbin.org	Envoy proxy'si tarafından kullanılan hedef uç nokta.
   API proxy'si	remote-service	Envoy bağdaştırıcısı kurulumu sırasında Apigee'de sağlanan remote-service proxy'si.
   Yol	Belirli bir yolla eşleşmesi için /resource_path girin. Örneğin: /httpbin.	Hedef uç noktada eşleştirilecek istek yolu. Bu yola yapılan API proxy çağrıları bu API ürünüyle eşleşir.

   Edge Public veya Private Cloud: Aşağıdaki ekran görüntüsünde, httpbin.org hedefi için düzgün şekilde yapılandırılmış iletişim kutusu ayarları gösterilmektedir. Bu, Apigee Edge Public veya Private Cloud için uygun bir yapılandırmadır.

   

6. Kaydet'i tıklayın.

4. Geliştirici Uygulaması Oluşturma

1. Yan gezinme menüsünde Yayınla > Uygulamalar'ı seçin.
2. + Uygulama'yı tıklayın.
3. Geliştirici uygulaması sayfasını aşağıdaki gibi doldurun. Kaydetme işlemi için talimat verilene kadar kaydetmeyin.

Ad	httpbin-app
Görünen ad	httpbin app
Developer	Daha önce oluşturduğunuz geliştiriciyi seçin veya listeden istediğiniz bir geliştiriciyi belirleyin.

4. Ardından, uygulamaya iki ürün ekleyin:
   1. Öncelikle Kimlik Bilgileri bölümünde + Ürün ekle'yi tıklayın ve yeni yapılandırdığınız ürünü (httpbin-product) seçin.
   2. Ardından, remote-service ürününü ekleyin. Bu ürün, Apigee'yi sağladığınızda otomatik olarak oluşturuldu.
5. Oluştur'u tıklayın.
6. Kimlik bilgileri bölümünde, Anahtar'ın yanındaki Göster'i tıklayın.
7. Tüketici anahtarının değerini kopyalayın. Bu değer, httpbin hizmetine API çağrıları yapmak için kullanacağınız API anahtarıdır.

API ürünleri hakkında

API ürünleri, Apigee Remote Service'in birincil kontrol noktasıdır. Bir API ürünü oluşturup hedef hizmete bağladığınızda, Apigee Adapter for Envoy'i işleyecek şekilde yapılandırdığınız tüm isteklere uygulanacak bir politika oluşturursunuz.

API ürünü tanımı

Apigee'de bir API ürünü tanımladığınızda, istekleri değerlendirmek için kullanılacak bir dizi parametre ayarlayabilirsiniz:

• Hedef
• Yol iste
• Kota
• OAuth kapsamları

Uzak Hizmet Hedefleri

İstek hem hedef bağlamayla (örneğin, httpbin.org) hem de istek yoluyla (örneğin, /httpbin) eşleşiyorsa API ürünü tanımı istek için geçerli olur. Olası hedeflerin listesi, API ürününde özellik olarak saklanır.

Apigee Remote Service, varsayılan olarak Envoy'un özel :authority (host) üstbilgisini hedef listesine göre kontrol eder ancak diğer üstbilgileri kullanacak şekilde yapılandırılabilir.

API Kaynak Yolu

Girilen yol, aşağıdaki kurallara göre eşleşir:

• Tek bir eğik çizgi (/) kendi başına tüm yollarla eşleşir.
• *, her yerde geçerlidir ve bir segment içinde (eğik çizgiler arasında) eşleşir.
• **, satırın sonunda geçerlidir ve satırın sonuna kadar her şeyle eşleşir.

Kota

Kota, bir uygulamanın bir saat, gün, hafta veya ay içinde bir API'ye göndermesine izin verilen istek mesajlarının sayısını belirtir. Bir uygulama kota sınırına ulaştığında sonraki API çağrıları reddedilir.

Kotalar, bir istemcinin belirli bir süre içinde bir hizmete yapabileceği istek sayısını zorunlu kılmanıza olanak tanır. Kotalar genellikle operasyonel trafik yönetimi için değil, geliştiriciler ve iş ortaklarıyla yapılan ticari sözleşmeleri veya hizmet düzeyi sözleşmelerini uygulamak için kullanılır. Örneğin, ücretsiz bir hizmetin trafiğini sınırlamak için kota kullanılabilirken ücretli müşterilere tam erişim izni verilebilir.

Kota parametreleri API ürünlerinde yapılandırılır. Örneğin, bir API ürünü oluşturduğunuzda izin verilen kota sınırını, zaman birimini ve aralığını isteğe bağlı olarak ayarlayabilirsiniz.

API anahtarları API ürünleriyle eşlendiğinden, bir API anahtarı her doğrulandığında uygun kota sayacı azaltılabilir (ilişkili üründe bir kota tanımlanmışsa).

Apigee çalışma zamanının aksine, ürün tanımına girilen kotalar Apigee Uzak Hizmeti tarafından otomatik olarak uygulanır. İstek yetkilendirilirse izin verilen kotaya göre sayılır.

Kotalar, Uzak Hizmet işlemi tarafından yerel olarak korunur ve kontrol edilir. Ayrıca, Apigee Runtime ile eşzamansız olarak korunur. Bu nedenle, kotayı koruyan birden fazla Uzak Hizmetiniz varsa kotalar kesin değildir ve bir miktar aşım olabilir. Apigee Runtime ile bağlantı kesilirse yerel kota, Apigee Runtime'a yeniden bağlanana kadar bağımsız bir kota olarak devam eder.

OAuth Kapsamları

JWT jetonları kullanıyorsanız jetonları izin verilen OAuth kapsamlarının alt kümeleriyle kısıtlayabilirsiniz. Verilen JWT jetonunuza atanan kapsamlar, API ürününün kapsamlarıyla karşılaştırılır.

Geliştirici uygulamaları hakkında

API ürünlerinizi yapılandırdıktan sonra bir geliştiriciyle ilişkili bir uygulama oluşturursunuz. Uygulama, bir istemcinin API anahtarı veya JWT jetonu ile ilişkili API ürünlerine erişmesine izin veriyor.

JWT tabanlı kimlik doğrulama kullanma

Kimliği doğrulanmış API proxy'si çağrıları yapmak için API anahtarı yerine JWT jetonu kullanabilirsiniz. Bu bölümde, JWT jetonları oluşturmak, incelemek ve döndürmek için apigee-remote-service-cli token komutunun nasıl kullanılacağı açıklanmaktadır.

Genel Bakış

JWT doğrulama ve kimlik doğrulama, Envoy'un JWT Authentication Filter'ı kullanılarak gerçekleştirilir.

Doğrulama yapıldıktan sonra Envoy ext-authz filtresi, istek başlıklarını ve JWT'yi apigee-remote-service-envoy'ye gönderir. İsteğin hedefiyle yetkilendirmek için JWT'nin api_product_list ve scope taleplerini Apigee API ürünleriyle eşleştirir.

Apigee JWT jetonları oluşturma

Apigee JWT jetonları CLI kullanılarak oluşturulabilir:

apigee-remote-service-cli token create -c config.yaml --id $KEY --secret $SECRET

Veya standart OAuth jeton uç noktasını kullanarak. Curl örneği:

curl https://org-env.apigee.net/remote-service/token -d '{"client_id":"myclientid","client_secret":"myclientsecret","grant_type":"client_credentials"}' -H "Content-type: application/json"

JWT jetonunu kullanma

Jetona sahip olduğunuzda, yetkilendirme başlığında Envoy'a iletmeniz yeterlidir. Örnek:

curl localhost:8080/httpbin/headers -i -H "Authorization:Bearer $TOKEN"

JWT jeton hatası

Envoy reddi

Envoy, jetonu reddederse şuna benzer bir mesaj görebilirsiniz:

Jwks remote fetch is failed

Bu durumda, Envoy yapılandırmanızın remote_jwks bölümünde geçerli bir URI içerdiğinden, Envoy'un bu URI'ye ulaşabildiğinden ve Apigee proxy'sini yüklerken sertifikaları doğru şekilde ayarladığınızdan emin olun. URI'yi doğrudan bir GET çağrısıyla çağırabilmeli ve geçerli bir JSON yanıtı alabilmelisiniz.

Örnek:

curl https://myorg-eval-test.apigee.net/remote-service/certs

Envoy'dan gelen diğer mesajlar şu şekilde görünebilir:

• "Jwt'deki kitlelere izin verilmiyor"
• "Jwt issuer is not configured" (JWT veren yapılandırılmamış)

Bunlar, Envoy yapılandırmanızdaki değiştirmeniz gerekebilecek şartlardan kaynaklanır.

Jetonu inceleme

Jetonunuzu incelemek için CLI'yı kullanabilirsiniz. Örnek

apigee-remote-service-cli -c config.yaml token inspect -f path/to/file

veya

apigee-remote-service-cli -c config.yaml token inspect <<< $TOKEN

Hata ayıklama

Günlük Kaydı

$REMOTE_SERVICE_HOME/apigee-remote-service-envoy hizmetinde günlük kaydı düzeyini ayarlayabilirsiniz. Tüm günlük kaydı stderr'ye gönderilir.

Envoy, günlük kaydı sağlar. Daha fazla bilgi için aşağıdaki Envoy doküman bağlantılarına bakın:

• Uygulama Günlüğü
• Erişim günlükleri
• GKE ile Stackdriver Logging

Ağ proxy'si kullanma

HTTP proxy, apigee-remote-service-envoy ikilisinin ortamında HTTP_PROXY ve HTTPS_PROXY ortam değişkenleri kullanılarak eklenebilir. Bunları kullanırken belirli ana makinelerin proxy üzerinden gönderilmesini hariç tutmak için NO_PROXY ortam değişkeni de kullanılabilir.

HTTP_PROXY=http://[user]:[pass]@[proxy_ip]:[proxy_port]
HTTPS_PROXY=http://[user]:[pass]@[proxy_ip]:[proxy_port]
NO_PROXY=127.0.0.1,localhost

Proxy'ye apigee-remote-service-envoy üzerinden erişilebilmesi gerektiğini unutmayın.

Metrikler ve analizler hakkında

Prometheus metrikleri uç noktası :5001/metrics adresinde kullanılabilir. Bu bağlantı noktası numarasını yapılandırabilirsiniz. Yapılandırma dosyası bölümüne bakın.

Envoy analizleri

Aşağıdaki bağlantılarda Envoy proxy analiz verilerini edinme hakkında bilgi verilmektedir:

• Yönetici arayüzü
• İstatistikler
• Küme istatistikleri

Istio analizleri

Aşağıdaki bağlantılarda Envoy proxy analiz verilerini edinme hakkında bilgi verilmektedir:

• Gözlemlenebilirlik görevleri
• Telemetri yapılandırması

Apigee analizi

Apigee Remote Service for Envoy, analiz işleme için istek istatistiklerini Apigee'ye gönderir. Apigee, bu istekleri ilişkili API ürünü adı altında bildirir.

Apigee Analytics hakkında bilgi edinmek için Analytics hizmetlerine genel bakış başlıklı makaleyi inceleyin.