इस सेक्शन में, Private Cloud कनेक्टर के लिए Apigee API Hub को कॉन्फ़िगर करने के तरीके के बारे में बताया गया है. इसमें नेटवर्क, पुष्टि करने, और संगठन के हिसाब से सेटिंग शामिल हैं.
नेटवर्क और पुष्टि करने की सुविधा का सेटअप
- पोर्ट को अनुमति देना: Apigee API Hub for Private Cloud कनेक्टर को ज़रूरी एपीआई मेटाडेटा पाने के लिए, मैनेजमेंट सर्वर से कनेक्ट करना होता है. इसलिए, कनेक्टर को मैनेजमेंट सर्वर के पोर्ट 8080 और 443 से कनेक्ट करने की अनुमति देनी होगी.
- Google Cloud Platform की सेवाओं के लिए, कुंजी के आधार पर पुष्टि करने की सुविधा: Private Cloud के लिए Apigee API Hub कनेक्टर, Google Cloud की सेवाओं के साथ कम्यूनिकेट करता है. इसके लिए, पुष्टि करने वाले टोकन की ज़रूरत होती है. इसके लिए, सेवा खाते की कुंजी का इस्तेमाल करके, नकली टोकन बनाए जाते हैं.
- टोकन जनरेट करने के लिए सेवा खाता: टोकन जनरेट करने के लिए, एक नया सेवा खाता बनाएं. इस सेवा खाते के पास
Token Creator
की भूमिका होनी चाहिए. - सेवा खाते की कुंजी जनरेट करना और डाउनलोड करना:
- टोकन जनरेट करने वाले सेवा खाते के लिए JSON कुंजी जनरेट करने के लिए, सेवा खाता कुंजी बनाएं में दिया गया तरीका अपनाएं.
- इस कुंजी फ़ाइल को डाउनलोड करें. उदाहरण के लिए, Private Cloud कनेक्टर वीएम के लिए Apigee API हब पर
/opt/apigee/keys/uapim.key
.
GOOGLE_APPLICATION_CREDENTIALS
सेट करें: Apigee API Hub for Private Cloud कनेक्टर का इस्तेमाल शुरू करते समय, आपको एनवायरमेंट वैरिएबल के ज़रिए इस फ़ाइल का पाथ देना होगा:export $GOOGLE_APPLICATION_CREDENTIALS=/opt/apigee/keys/uapim.key
- टोकन जनरेट करने के लिए सेवा खाता: टोकन जनरेट करने के लिए, एक नया सेवा खाता बनाएं. इस सेवा खाते के पास
- Management API की पुष्टि करना (UAPIM_MGMT_AUTH): Apigee API Hub for Private Cloud कनेक्टर को Apigee Management API को कॉल करने के लिए क्रेडेंशियल की ज़रूरत होती है. सुरक्षा और ऑटोमेशन के लिए, Apigee में मशीन उपयोगकर्ता का इस्तेमाल करें, न कि किसी व्यक्ति का.
Apigee में मशीन उपयोगकर्ता बनाने के लिए:
- उपयोगकर्ता बनाएं:
- Apigee कंसोल में, मशीन उपयोगकर्ता (या सिस्टम उपयोगकर्ता) बनाएं. उपयोगकर्ताओं और भूमिकाओं के बारे में यहां ज़्यादा जानें टोकन जनरेट करने की प्रोसेस को अपने-आप होने वाली प्रोसेस के तौर पर सेट अप करना.
- पहचान के लिए एक ईमेल पता और ज़्यादा जानकारी देने वाला नाम असाइन करें. उदाहरण के लिए,
uapim-connector-user
).
- भूमिकाएं असाइन करना: मशीन उपयोगकर्ता को यह भूमिका असाइन करें:
- Apigee API एडमिन: इस भूमिका से मैनेजमेंट एपीआई का ऐक्सेस मिलता है. इससे Apigee API Hub for Private Cloud कनेक्टर, Apigee के मैनेजमेंट सिस्टम के साथ इंटरैक्ट कर पाता है. उदाहरण के लिए, मेटाडेटा फ़ेच करने या एपीआई कॉन्फ़िगरेशन मैनेज करने के लिए.
- उपयोगकर्ता बनाएं:
Base64 कोड में बदले गए क्रेडेंशियल जनरेट करें:
- मशीन उपयोगकर्ता के लिए, उपयोगकर्ता नाम:पासवर्ड का पेयर जनरेट करें.
- क्रेडेंशियल को Base64 में बदलें:
echo -n 'username:password' | base64
- एनवायरमेंट वैरिएबल $UAPIM_MGMT_AUTH को base64-encoded वैल्यू के साथ सेट करें:
export UAPIM_MGMT_AUTH=USERNAME_PASSWORD
यहां USERNAME_PASSWORD, उपयोगकर्ता नाम और पासवर्ड के जोड़े की base64 कोड में बदली गई वैल्यू है.
Apigee API Hub for Private Cloud कनेक्टर शुरू करने से पहले, पक्का करें कि यह एनवायरमेंट वैरिएबल सेट हो.
Private Cloud कनेक्टर के लिए Apigee API Hub को कॉन्फ़िगर करना
कॉन्फ़िगरेशन फ़ाइल /opt/apigee/customer/application/uapim-connector.properties
खोलें. इसमें उन Apigee संगठनों के बारे में बताएं जिनके लिए API Hub पर डेटा अपलोड करना है. आपके पास एक से ज़्यादा प्लगिन इंस्टेंस या एक से ज़्यादा API हब इंस्टेंस हो सकते हैं.
conf_uapim.settings.json={\ "connectorConfig" : { \ "org1" : { \ "runtimeDataPubsub" : "", \ "metadataPubsub":"", \ "serviceAccount": "mysa1@in.myfirstProject",\ "pluginInstanceId":"aaaa" \ },\ "org2" : { \ "runtimeDataPubsub" : "", \ "metadataPubsub":"",\ "serviceAccount": "mysa2@in.mySecondProject",\ "pluginInstanceId":"bbbbb", \ } }, "runtimeDataPath":"/the/nfs/mounted/path", \ "managementServer": "hostname" }
सेटिंग के JSON के बारे में जानकारी
- connectorConfig Section:
- यह एक मैप है, जिसमें हर कुंजी Apigee संगठन का नाम है. जैसे, org1, org2.
- संगठन की हर एंट्री में ये फ़ील्ड शामिल होते हैं. ये फ़ील्ड आपको प्लगिन बनाने के चरण के दौरान मिले थे:
- runtimeDataPubsub: इस संगठन के लिए, रनटाइम (ऐनलिटिक्स) डेटा का Pub/Sub विषय.
- metadataPubsub: इस संगठन के लिए, एपीआई मेटाडेटा का Pub/Sub विषय.
- serviceAccount: यह सेवा खाता (जैसे, mysa1@in.myfirstProject.iam.gserviceaccount.com) इस संगठन के लिए Pub/Sub में डेटा लिखने के लिए पुष्टि करने के लिए इस्तेमाल किया जाता है.
- pluginInstanceId: इस संगठन से जुड़े प्लगिन का यूनीक इंस्टेंस आईडी.
- runtimeDataPath सेक्शन: उस NFS माउंट का पाथ दें जहां मैसेज प्रोसेसर, Analytics (AX) का डेटा लिखेंगे. यह वही पाथ होना चाहिए जिसे मैसेज प्रोसेसर पर कॉन्फ़िगर किया गया है.
- managementServer सेक्शन: Apigee मैनेजमेंट सर्वर के यूआरएल का होस्टनेम या आईपी पता.
- environment variable UAPIM_MGMT_AUTH: यह एनवायरमेंट वैरिएबल, बाहरी तौर पर सेट किया जाता है. इसमें मैनेजमेंट सर्वर को ऐक्सेस करने के लिए, base64 कोड में बदला गया username:password होता है.
फ़ॉरवर्ड प्रॉक्सी कॉन्फ़िगरेशन जोड़ना
उसी फ़ाइल /opt/apigee/customer/application/uapim-connector.properties
में फ़ॉरवर्ड प्रॉक्सी कॉन्फ़िगरेशन जोड़ें
conf_http_client_service_jetty.proxy.enabled=true
conf_http_client_service_jetty.proxy.host=
conf_http_client_service_jetty.proxy.port=
conf_http_client_service_jetty.proxy.user=
conf_http_client_service_jetty.proxy.password=
कनेक्टर को सही तरीके से काम करने के लिए, इसे इन बाहरी सोर्स से कनेक्ट करना होगा:
pubsub.googleapis.com:443
oauth2.googleapis.com:443
iamcredentials.googleapis.com:443
अगर कनेक्टर को सीधे तौर पर बाहरी सोर्स से कनेक्ट करने की अनुमति नहीं है, लेकिन फ़ॉरवर्ड प्रॉक्सी के ज़रिए कनेक्ट करने की अनुमति है, तो उपयोगकर्ता को नीचे दिए गए कॉन्फ़िगरेशन के ज़रिए फ़ॉरवर्ड प्रॉक्सी कॉन्फ़िगरेशन देना होगा. साथ ही, यह पक्का करना होगा कि ऊपर बताए गए बाहरी सोर्स को अनुमति दी गई हो.
Apigee API Hub for Private Cloud Connector को शुरू करना
सभी कॉन्फ़िगरेशन सेट हो जाने के बाद, Apigee सेवा के निर्देश का इस्तेमाल करके, Apigee API Hub for Private Cloud कनेक्टर शुरू करें:
apigee-service edge-uapim-connector start