Apigee Edge के साथ Envoy के लिए Apigee अडैप्टर का इस्तेमाल करना

आपको Apigee Edge दस्तावेज़ दिख रहा है.
Apigee X के दस्तावेज़ पर जाएं.
जानकारी

इस उदाहरण में, Apigee Edge के साथ Envoy के लिए Apigee अडैप्टर का इस्तेमाल करने का तरीका बताया गया है.

ज़रूरी शर्तें

शुरू करने से पहले:

खास जानकारी

इस उदाहरण में, Public Cloud के लिए Apigee Edge के साथ Envoy के लिए Apigee अडैप्टर का इस्तेमाल करने का तरीका बताया गया है. एपीआई प्रोक्सी कॉल, Envoy के ज़रिए फ़्लो होते हैं. Envoy, नेटिव ऐप्लिकेशन के तौर पर काम करता है. साथ ही, Edge के साथ मिलकर एपीआई मैनेजमेंट सेवाएं देता है. इसके लिए, Envoy के लिए Apigee रिमोट सेवा का इस्तेमाल किया जाता है.

Apigee Edge का प्रावधान करना

इस चरण में, आपको रिमोट सेवा CLI का इस्तेमाल करके, Envoy एसेट के लिए Apigee अडैप्टर को 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 को प्रोविज़न करने के लिए इस निर्देश का इस्तेमाल करें:

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

    अगर आपको अपग्रेड करना है, तो Apigee को प्रोविज़न करने के लिए, --force-proxy-install फ़्लैग के साथ इस कमांड का इस्तेमाल करें:

    $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 फ़ाइल के कॉन्टेंट की जांच करें. यह कुछ ऐसा दिखना चाहिए:
    # 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 के अनुरोधों की पुष्टि करने के लिए किया जाता है.

Envoy सेवा के लिए Apigee रिमोट सेवा चलाना

रिमोट सेवा को नेटिव बाइनरी के तौर पर या Docker पर चलाया जा सकता है.

सेवा को नेटिव तौर पर चलाएं

कॉन्फ़िगरेशन फ़ाइल के साथ सेवा बाइनरी को चलाएं. यह फ़ाइल, प्रोवाइज़न करने के लिए दिए गए निर्देश से जनरेट होती है:

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

Docker पर सेवा चलाना

Docker इमेज, रिलीज़ टैग के साथ पब्लिश की जाती हैं. इसे इंस्टॉल करने के लिए, सबसे नए वर्शन का इस्तेमाल करें. इमेज के लिए, ये तीन वैरिएशन चुने जा सकते हैं:

अलग-अलग तरह का कॉन्टेंट इमेज
Google distroless google/apigee-envoy-adapter:v2.0.0
Ubuntu google/apigee-envoy-adapter:v2.0.0-ubuntu
बोरिंग क्रिप्टो के साथ Ubuntu google/apigee-envoy-adapter:v2.0.0-boring

उदाहरण के लिए, वॉल्यूम माउंट के ज़रिए /config.yaml के तौर पर उपलब्ध अपने लोकल config.yaml के साथ स्क्रैच इमेज चलाने के लिए, इस निर्देश का इस्तेमाल करें:

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

सैंपल कॉन्फ़िगरेशन फ़ाइलें बनाना

सीएलआई का इस्तेमाल करके एक Envoy कॉन्फ़िगरेशन फ़ाइल जनरेट करें:

  1. पक्का करें कि आप $ENVOY_HOME डायरेक्ट्री में हों.
  2. उपलब्ध कॉन्फ़िगरेशन टेंप्लेट की सूची बनाएं:
    $CLI_HOME/apigee-remote-service-cli samples templates
  3. सैंपल कमांड को लागू करें. TEMPLATE के लिए, Envoy के किसी ऐसे टेंप्लेट का इस्तेमाल करें जो काम करता हो:

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

    निर्देश, ./samples/envoy-config.yaml फ़ाइल बनाता है.

ज़्यादा जानकारी के लिए, सैंपल का निर्देश देखें.

Envoy प्रॉक्सी को इंस्टॉल और चलाना

Envoy प्रॉक्सी इंस्टॉल करने और चलाने के लिए, यह तरीका अपनाएं:

  1. Envoy बाइनरी डाउनलोड करें या उसे बिल्ड करें या Docker का इस्तेमाल करें.
  2. httpbin.org सेवा के लिए पहले जनरेट की गई सैंपल कॉन्फ़िगरेशन फ़ाइल का इस्तेमाल करके, Envoy चलाएं:
    envoy -c ./samples/envoy-config.yaml

इंस्टॉलेशन की जांच करना

  1. किसी एपीआई प्रॉडक्ट को कॉन्फ़िगर करें और एपीआई पासकोड पाएं, जैसा कि एपीआई पासकोड पाने का तरीका में बताया गया है.
  2. एपीआई कुंजी के बिना httpbin सेवा को कॉल करें:
    curl -i http://localhost:8080/headers -H "HOST:httpbin.org"
    

    इस सेवा को अब Apigee मैनेज कर रहा है. आपने एपीआई पासकोड नहीं दिया है, इसलिए कॉल से यह गड़बड़ी दिखेगी.

    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. पासकोड का इस्तेमाल करके एपीआई कॉल करें:
    export APIKEY=YOUR_API_KEY
    curl -i http://localhost:8080/headers \
    -H "HOST:httpbin.org" -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"
      }
    }

अगले चरण

httpbin सेवा के लिए, एपीआई ट्रैफ़िक को अब Apigee मैनेज करता है. यहां कुछ ऐसी सुविधाएं दी गई हैं जिन्हें एक्सप्लोर करके आज़माया जा सकता है:

  • अगर आपने अपने एपीआई प्रॉडक्ट को एपीआई पासकोड पाने का तरीका में बताए गए तरीके के मुताबिक कॉन्फ़िगर किया है, तो कोटा की सीमा हर मिनट में पांच अनुरोधों पर सेट की गई थी. कोटा ट्रिगर करने के लिए, httpbin सेवा को कुछ बार और कॉल करने की कोशिश करें. कोटा खत्म होने पर, एचटीटीपी स्टेटस 403 वाली गड़बड़ी का मैसेज दिखता है.
  • Edge यूज़र इंटरफ़ेस (यूआई) में Apigee Analytics ऐक्सेस करें. विश्लेषण करें > एपीआई मेट्रिक > एपीआई प्रोक्सी की परफ़ॉर्मेंस पर जाएं.
  • एपीआई कॉल की पुष्टि करने के लिए, JWT टोकन जनरेट और इस्तेमाल करें.
  • टोकन बनाने, मैनेज करने, और बाइंडिंग कंट्रोल करने के लिए सीएलआई का इस्तेमाल करें. सीएलआई के बारे में ज़्यादा जानकारी के लिए, रेफ़रंस देखें.