استخدام محوِّل Apigee لخدمة Envoy مع Apigee Edge

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
info

يوضّح هذا المثال كيفية استخدام Apigee Adapter for Envoy مع Apigee Edge.

المتطلبات الأساسية

قبل البدء:

نظرة عامة

يوضّح هذا المثال كيفية استخدام "محوّل Apigee" لـ Envoy مع Apigee Edge for Public Cloud. تنتقل طلبات البيانات من واجهة برمجة التطبيقات عبر Envoy الذي يعمل كتطبيق أصلي مع توفير Edge لخدمات إدارة واجهة برمجة التطبيقات من خلال Apigee Remote Service for Envoy.

يوضّح الشكل التالي البنية الأساسية لعملية الدمج في Apigee Edge:

نظرة عامة على Envoy Adapter الذي يعمل بشكل أصلي للتواصل مع Apigee Edge Cloud، بما في ذلك مستوى الإدارة ومستوى وقت التشغيل وخدمات Google Cloud Platform

يتم تشغيل وكيل Envoy وRemote Service محليًا. تتعامل Envoy مع عدد الزيارات إلى واجهة برمجة التطبيقات من الخدمة المستهدَفة وإليها، وتتواصل مع "الخدمة البعيدة". تتواصل "الخدمة البعيدة" أيضًا مع Apigee Edge Cloud لاسترداد معلومات حول منتج واجهة برمجة التطبيقات والوكيل.

توفير Apigee Edge

في هذه الخطوة، ستستخدِم واجهة سطر الأوامر الخاصة بالخدمة البعيدة لتوفير مواد عرض Apigee Adapter for Envoy إلى Apigee Edge. ينشر أمر التوفير خادم وكيل لواجهة برمجة التطبيقات على Apigee Edge، ويُعدّ أيضًا شهادة على Apigee، ويُنشئ بيانات اعتماد ستستخدمها الخدمة البعيدة للاتصال بشكل آمن من نظامك إلى Apigee.

  1. انتقِل إلى دليل $CLI_HOME:
    cd $CLI_HOME
  2. أنشئ متغيّرات البيئة التالية. سيتم استخدام هذه المتغيّرات كمَعلمات لنص البرمجة الخاص بتوفير الموارد:
    export ORG=organization_name
    export ENV=environment_name
    export USER=your_apigee_username
    export PASSWORD=your_apigee_password

    المكان:

    متغيّر الوصف
    organization_name اسم مؤسسة Apigee
    environment_name اسم بيئة في مؤسستك
    your_apigee_username اسم المستخدم لحسابك على Apigee عادةً ما يكون اسم المستخدم هو عنوان بريد إلكتروني.
    your_apigee_password كلمة مرور Apigee
  3. نفِّذ الأمر التالي لتوفير وكيل الخدمة البعيدة على Apigee Edge:
    ./apigee-remote-service-cli provision --legacy --mfa $MFA --username $USER --password $PASSWORD \
        --organization $ORG --environment $ENV > config.yaml
  4. تحقَّق من محتوى الملف config.yaml. من المفترض أن تظهر بشكلٍ مشابه لما يلي:
    # 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

    يتم استخدام قيم المفتاح والسّر للتحقّق من صحة الطلبات من الخادم الوكيل للخدمة عن بُعد إلى Apigee Edge.

تشغيل خدمة Apigee Remote Service for Envoy

يمكنك تشغيل "الخدمة البعيدة" إما كملف ثنائي أصلي أو على Docker.

تشغيل الخدمة بشكل أصلي

نفِّذ ملف الخدمة الثنائي باستخدام ملف الإعداد الذي تم إخراجه من أمر الإعداد:

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

تشغيل الخدمة على Docker

يتم نشر صور Docker باستخدام علامات الإصدار. يجب استخدام أحدث إصدار من التطبيق في عملية التثبيت هذه. تتوفّر ثلاثة أشكال مختلفة من الصور للاختيار من بينها:

التنويع صورة
Google distroless gcr.io/distroless/base
Ubuntu google/apigee-envoy-adapter:v1.1.0-ubuntu
Ubuntu with Boring Crypto google/apigee-envoy-adapter:v1.1.0-boring

على سبيل المثال، لتشغيل صورة تجريبية مع توفُّر config.yaml المحلي كـ /config.yaml من خلال ربط وحدة تخزين، استخدِم الأمر التالي:

docker run -v ./config.yaml:/config.yaml google/apigee-envoy-adapter:v1.1.0

إنشاء نماذج لملفات الإعداد

استخدِم الأمر apigee-remote-service-cli samples create لإنشاء ملفات إعداد نموذجية.

في هذا المثال، تحتاج إلى الملفات التي تم إنشاؤها التالية:

  • envoy-config.yaml: إعداد نشر لخدمة HTTP.

لإنشاء النماذج، اتّبِع الخطوات التالية:

  1. انتقِل إلى الدليل $CLI_HOME.
  2. نفِّذ الأمر التالي لإنشاء الملفات:

    ./apigee-remote-service-cli samples create --template native -c ./config.yaml

    يتم إخراج الملفات التالية إلى الدليل ./samples:

    ls samples
    envoy-config.yaml
    

لمزيد من المعلومات، يُرجى الاطّلاع على أمر العيّنات.

تثبيت خادم Envoy الوكيل وتشغيله

اتّبِع الخطوات التالية لتثبيت خادم وكيل Envoy وتشغيله:

  1. نزِّل ملفًا ثنائيًا من Envoy أو أنشئ الملف، أو استخدِم Docker.
  2. شغِّل Envoy باستخدام ملف إعداد نموذجي أنشأته سابقًا لخدمة httpbin.org:
    envoy -c $CLI_HOME/samples/envoy-config.yaml

اختبار التثبيت

  1. الاتصال بخدمة httpbin:
    curl -i http://localhost:8080/httpbin/headers
    

    تتم إدارة الخدمة الآن من خلال Apigee، وبما أنّك لم تقدّم مفتاح واجهة برمجة تطبيقات، يعرض الطلب الخطأ التالي.

    curl -i http://localhost:8080/httpbin/headers
    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
  2. اضبط منتج واجهة برمجة التطبيقات واحصل على مفتاح واجهة برمجة التطبيقات كما هو موضّح في مقالة كيفية الحصول على مفتاح واجهة برمجة التطبيقات.
  3. إجراء طلب بيانات من واجهة برمجة التطبيقات باستخدام المفتاح:
    export APIKEY=YOUR_API_KEY
    curl -i http://localhost:8080/httpbin/headers -H "x-api-key: $APIKEY"

    يجب أن ينجح الطلب مع عرض الحالة 200 وإرجاع قائمة بالعناوين في الرد. على سبيل المثال:

    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"
      }
    }

الخطوات التالية

تتولّى Apigee الآن إدارة عدد الزيارات إلى واجهة برمجة التطبيقات لخدمة httpbin. في ما يلي بعض الميزات التي يمكنك استكشافها وتجربتها:

  • إذا كنت قد أعددت منتج واجهة برمجة التطبيقات كما هو موضّح في كيفية الحصول على مفتاح واجهة برمجة التطبيقات، تم ضبط الحد الأقصى للحصة على 5 طلبات في الدقيقة. حاوِل الاتصال بخدمة httpbin عدة مرات أخرى لتفعيل الحصة. عند استنفاد الحصة، يتم عرض خطأ في حالة HTTP 403.
  • الوصول إلى Apigee Analytics في واجهة مستخدم Edge انتقِل إلى تحليل > مقاييس واجهة برمجة التطبيقات > أداء خادم وكيل واجهة برمجة التطبيقات.
  • إنشاء رموز JWT المميزة واستخدامها للمصادقة على طلبات البيانات من واجهة برمجة التطبيقات
  • استخدِم واجهة سطر الأوامر لإدارة الرموز المميزة وإنشائها والتحكّم في عمليات الربط. للحصول على تفاصيل حول واجهة سطر الأوامر، يُرجى الاطّلاع على المرجع.