Apigee Edge ile Apigee Adapter for Envoy'u kullanma

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

Bu örnekte, Apigee Edge ile Envoy için Apigee bağdaştırıcının nasıl kullanılacağı gösterilmektedir.

Ön koşullar

Başlamadan önce:

Genel Bakış

Bu örnekte, Genel Cloud için Apigee Edge ile Envoy için Apigee Adapter'ın nasıl kullanılacağı açıklanmaktadır. API proxy çağrıları, Edge'in Envoy için Apigee Remote Service üzerinden API yönetim hizmetleri sağladığı yerel bir uygulama olarak çalışan Envoy üzerinden akar.

Apigee Edge'i sağlama

Bu adımda, Envoy öğeleri için Apigee Adapter'ı Apigee Edge'e sağlamak üzere Remote Service CLI'yi kullanacaksınız. Hazırlama komutu, Apigee Edge'e bir API proxy'si dağıtır ve Apigee'de bir sertifika oluşturur. Ayrıca, uzak hizmetin sisteminizden Apigee'ye güvenli bir şekilde bağlanmak için kullanacağı kimlik bilgilerini oluşturur.

  1. $CLI_HOME dizinine gidin:
    cd $CLI_HOME
  2. Aşağıdaki ortam değişkenlerini oluşturun. Bu değişkenler, temel hazırlama komut dosyasının parametreleri olarak kullanılır:
    export ORG=organization_name
    export ENV=environment_name
    export USER=your_apigee_username
    export PASSWORD=your_apigee_password

    Burada:

    Değişken Açıklama
    organization_name Apigee kuruluşunuzun adı.
    environment_name Kuruluşunuzda bir ortamın adı.
    your_apigee_username Apigee hesabınızın kullanıcı adı. Kullanıcı adı genellikle bir e-posta adresidir.
    your_apigee_password Apigee şifreniz.
  3. Apigee Edge'de uzak hizmet proxy'sini sağlamak için aşağıdaki komutu yürütün:

    Yükseltme kullanmıyorsanız Apigee'nin temel hazırlığını yapmak için şu komutu kullanın:

    $CLI_HOME/apigee-remote-service-cli provision --legacy --mfa $MFA \
      --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml

    Yükseltme yapıyorsanız Apigee için temel hazırlığı yapmak üzere bu komutu --force-proxy-install işaretiyle kullanın:

    $CLI_HOME/apigee-remote-service-cli provision --legacy --force-proxy-install --mfa $MFA \
      --username $USER --password $PASSWORD --organization $ORG --environment $ENV > config.yaml
  4. config.yaml dosyasının içeriğini kontrol edin. Şuna benzer bir görünüme sahip olmalıdır:
    # Configuration for apigee-remote-service-envoy (platform: SaaS)
    # generated by apigee-remote-service-cli provision on 2020-08-26 09:43:41
    apiVersion: v1
    kind: ConfigMap
    metadata:
      name: apigee-remote-service-envoy
      namespace: apigee
    data:
      config.yaml: |
        tenant:
          internal_api: https://istioservices.apigee.net/edgemicro
          remote_service_api: https://my-username-test.apigee.net/remote-service
          org_name: my-org
          env_name: my-env
          key: f7e09c32f827cab87b8ce43842ed8467ffd2c58e6f795241e38fe7b1aec7664
          secret: 1cb5cca00dfb433cb80b32837451fce4bf694633cddbb73d704517e12b35e75
       ...

    Anahtar ve gizli değerler, uzak hizmet proxy'sinden Apigee Edge'e gönderilen isteklerin doğrulanması için kullanılır.

Envoy hizmeti için Apigee Remote Service'i çalıştırma

Uzak Hizmeti yerel bir ikili dosya olarak veya Docker'da çalıştırabilirsiniz.

Hizmeti yerel olarak çalıştırma

Temel hazırlık komutu tarafından oluşturulan yapılandırma dosyasını kullanarak hizmet ikili programını yürütün:

$REMOTE_SERVICE_HOME/apigee-remote-service-envoy -c config_file_path/config.yaml

Hizmeti Docker'da çalıştırma

Docker görüntüleri, sürüm etiketleriyle yayınlanır. Bu yükleme için en son sürümü kullanın. Üç resim varyantı arasından seçim yapabilirsiniz:

Çeşitlilik Resim
Google dağıtımsız google/apigee-envoy-adapter:v2.0.0
Ubuntu google/apigee-envoy-adapter:v2.0.0-ubuntu
Boring Crypto ile Ubuntu google/apigee-envoy-adapter:v2.0.0-boring

Örneğin, scratch görüntüsünü bir birim bağlama üzerinden /config.yaml olarak kullanılabilen yerel config.yaml ile çalıştırmak için şu komutu kullanın:

docker run -v ./config.yaml:/config.yaml google/apigee-envoy-adapter:v2.0.0

Örnek yapılandırma dosyaları oluşturma

KSA'yı kullanarak bir Envoy yapılandırma dosyası oluşturun:

  1. $ENVOY_HOME dizininde olduğunuzdan emin olun.
  2. Kullanılabilir yapılandırma şablonlarını listeleyin:
    $CLI_HOME/apigee-remote-service-cli samples templates
  3. samples komutunu çalıştırın. TEMPLATE yerine, desteklenen Envoy şablonlarından birini kullanın:

    $CLI_HOME/apigee-remote-service-cli samples create --template TEMPLATE -c ./config.yaml

    Komut, ./samples/envoy-config.yaml dosyasını oluşturur.

Daha fazla bilgi için Samples komutu başlıklı makaleyi inceleyin.

Envoy proxy'yi yükleyip çalıştırma

Envoy proxy'yi yüklemek ve çalıştırmak için aşağıdaki adımları uygulayın:

  1. Envoy ikilisini indirin veya derleyin ya da Docker'ı kullanın.
  2. httpbin.org hizmeti için daha önce oluşturduğunuz örnek bir yapılandırma dosyasını kullanarak Envoy'u çalıştırın:
    envoy -c ./samples/envoy-config.yaml

Yüklemeyi test etme

  1. API anahtarı edinme bölümünde açıklandığı şekilde bir API ürünü yapılandırıp API anahtarı alın.
  2. httpbin hizmetini API anahtarı olmadan çağırma:
    curl -i http://localhost:8080/headers -H "HOST:httpbin.org"
    

    Bu hizmet artık Apigee tarafından yönetiliyor. API anahtarı sağlamadığınız için çağrı aşağıdaki hatayı döndürüyor.

    curl -i http://localhost:8080/headers -H "HOST:httpbin.org"
    HTTP/1.1 403 Forbidden
    date: Tue, 12 May 2020 17:51:36 GMT
    server: envoy
    content-length: 0
    x-envoy-upstream-service-time: 11
  3. Aşağıdaki anahtarı kullanarak API çağrısı yapın:
    export APIKEY=YOUR_API_KEY
    curl -i http://localhost:8080/headers \
    -H "HOST:httpbin.org" -H "x-api-key: $APIKEY"

    Çağrı, 200 durumuyla başarılı olmalı ve yanıtta bir üstbilgi listesi döndürmelidir. Örneğin:

    curl -i httpbin.default.svc.cluster.local/headers -H "x-api-key: kyOTalNNLMPfOSy6rnVeclmVSL6pA2zS"
    HTTP/1.1 200 OK
    server: envoy
    date: Tue, 12 May 2020 17:55:34 GMT
    content-type: application/json
    content-length: 828
    access-control-allow-origin: *
    access-control-allow-credentials: true
    x-envoy-upstream-service-time: 301
    
    {
      "headers": {
        "Accept": "*/*",
        "Content-Length": "0",
        "Host": "httpbin.default.svc.cluster.local",
        "User-Agent": "curl/7.70.0-DEV",
        "X-Api-Key": "kyOTalNNLMPfOSy6rneclmVSL6pA2zS",
        "X-Apigee-Accesstoken": "",
        "X-Apigee-Api": "httpbin.default.svc.cluster.local",
        "X-Apigee-Apiproducts": "httpbin",
        "X-Apigee-Application": "httpbin",
        "X-Apigee-Authorized": "true",
        "X-Apigee-Clientid": "kyOTalNNLMPfOSy6rVeclmVSL6pA2zS",
        "X-Apigee-Developeremail": "user@example.com",
        "X-Apigee-Environment": "test",
        "X-Apigee-Organization": "my-org",
        "X-Apigee-Scope": "",
        "X-B3-Parentspanid": "1476f9a2329bbdfa",
        "X-B3-Sampled": "0",
        "X-B3-Spanid": "1ad5c19bfb4bc96f",
        "X-B3-Traceid": "6f329a34e8ca07811476f9a2329bbdfa"
      }
    }

Sonraki adımlar

httpbin hizmetine giden API trafiği artık Apigee tarafından yönetilmektedir. Keşfedebileceğiniz ve deneyebilirsiniz bazı özellikler:

  • API ürününüzü API anahtarı edinme bölümünde açıklandığı şekilde yapılandırdıysanız kota sınırı, dakika başına 5 istek olarak ayarlanmıştır. Kotayı tetiklemek için httpbin hizmetini birkaç kez daha çağırmayı deneyin. Kota tükendiğinde HTTP durum 403 hatası döndürülür.
  • Edge kullanıcı arayüzünde Apigee Analytics'e erişin. Analizin > API Metrikleri > API Proxy Performansı'na gidin.
  • API çağrılarının kimliğini doğrulamak için JWT jetonları oluşturun ve kullanın.
  • Bağlamaları yönetmek, jeton oluşturmak ve kontrol etmek için CLI'yi kullanın. CLI ayrıntıları için Referans bölümüne bakın.