रेफ़रंस

Apigee Edge का दस्तावेज़ देखा जा रहा है.
Apigee X के दस्तावेज़ पर जाएं.
info

apigee-remote-service-cli कमांड लाइन इंटरफ़ेस (सीएलआई) की मदद से, Apigee Adapter for Envoy को प्रोविज़न और मैनेज किया जा सकता है.

कमांड बाइंड करना

बाइंडिंग, Istio मेश में डिप्लॉय की गई सेवा को Apigee API प्रॉडक्ट से जोड़ती है. सीएलआई की मदद से, बाइंडिंग बनाई, हटाई, सूची में शामिल की, और पुष्टि की जा सकती हैं.

कोई बाइंडिंग जोड़ना

इस तरीके का इस्तेमाल करके, किसी एपीआई प्रॉडक्ट में रिमोट सर्विस टारगेट बाइंडिंग जोड़ी जाती है.

इस्तेमाल

Edge Public Cloud के लिए:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Edge Private Cloud के लिए:

apigee-remote-service-cli bindings add [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

कहां:

  • target_name, रिमोट सेवा के उस टारगेट का नाम है जिसे प्रॉडक्ट से बाइंड करना है.
  • product_name उस प्रॉडक्ट का नाम है जिससे सेवा को लिंक करना है.

झंडे

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, कमांड के ज़्यादातर पैरामीटर हटाए जा सकते हैं. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. --config विकल्प का इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का कोई एनवायरमेंट.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
--insecure एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन की अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें. यह Edge Cloud के लिए मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee का कई चरणों में पुष्टि करने वाला टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर Apigee Edge for Private Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) Apigee संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-p, --password स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड देने का विकल्प होता है. ऐसा करने पर, आपको कमांड लाइन पर अपना पासवर्ड देने की ज़रूरत नहीं होती. यह भी देखें क्रेडेंशियल के लिए .netrc का इस्तेमाल करना.
-r, --runtime स्ट्रिंग (सिर्फ़ Private Cloud के लिए) इससे आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल के बारे में पता चलता है.
-t, --token स्ट्रिंग (सिर्फ़ OAuth टोकन की पुष्टि के लिए ज़रूरी है) एक OAuth या SAML टोकन, जिसे आपने Apigee खाते की जानकारी से जनरेट किया है. टोकन जनरेट करने के बारे में जानकारी के लिए, get_token का इस्तेमाल करना और एसएएमएल की मदद से Management API को ऐक्सेस करना लेख पढ़ें.
-u, --username स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है) आपका Apigee उपयोगकर्ता नाम. आम तौर पर, यह एक ईमेल पता होता है. .netrc फ़ाइल में, उपयोगकर्ता नाम की जानकारी देना ज़रूरी नहीं है. ऐसा करने पर, आपको कमांड लाइन पर अपना उपयोगकर्ता नाम देने की ज़रूरत नहीं होती. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-v, --verbose (ज़रूरी नहीं) इससे वर्बोस आउटपुट मिलता है.

उदाहरण

./apigee-remote-service-cli bindings add httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is now bound to: httpbin.org

सूची में डेटा बाइंड करना

Remote Service से जुड़े सभी एपीआई प्रॉडक्ट की सूची बनाएं.

इस्तेमाल

Edge Public Cloud के लिए:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password]

Edge Private Cloud के लिए:

apigee-remote-service-cli bindings list -o [organization] -e [environment] -u [username] -p [password] -r [runtime] 

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, कमांड के ज़्यादातर पैरामीटर हटाए जा सकते हैं. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. --config विकल्प का इस्तेमाल करना..
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का कोई एनवायरमेंट.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
--insecure एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन की अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें. यह Edge Cloud के लिए मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee का कई चरणों में पुष्टि करने वाला टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर Apigee Edge for Private Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) Apigee संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-p, --password स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड देने का विकल्प होता है. ऐसा करने पर, आपको कमांड लाइन पर अपना पासवर्ड देने की ज़रूरत नहीं होती. यह भी देखें क्रेडेंशियल के लिए .netrc का इस्तेमाल करना.
-r, --runtime स्ट्रिंग (सिर्फ़ Private Cloud के लिए) इससे आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल के बारे में पता चलता है.
-t, --token स्ट्रिंग (सिर्फ़ OAuth टोकन की पुष्टि के लिए ज़रूरी है) OAuth या SAML टोकन, जिसे आपने Apigee खाते की जानकारी से जनरेट किया है. टोकन जनरेट करने के बारे में जानकारी के लिए, get_token का इस्तेमाल करना और एसएएमएल की मदद से मैनेजमेंट एपीआई को ऐक्सेस करना लेख पढ़ें.
-u, --username स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है) आपका Apigee उपयोगकर्ता नाम. आम तौर पर, यह एक ईमेल पता होता है. .netrc फ़ाइल में, उपयोगकर्ता नाम की जानकारी देना ज़रूरी नहीं है. ऐसा करने पर, आपको कमांड लाइन पर अपना उपयोगकर्ता नाम देने की ज़रूरत नहीं होती. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-v, --verbose (ज़रूरी नहीं) इससे वर्बोस आउटपुट मिलता है.

उदाहरण

apigee-remote-service-cli bindings list -o myorg -e test -u user@example.com -c config.yaml -p abc123
PI Products
============
Bound
-----
envoy-test:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
httpbin:
  Quota: 5 requests every 1 minute
  Target bindings:
    httpbin.org
  Paths:
    /httpbin
    /

Unbound
-------
product-1:
  Quota: 100 requests every 1 hour
product-2:
  Quota: 1000 requests every 1 month
product-3:
product-4:

बाइंडिंग हटाना

किसी एपीआई प्रॉडक्ट से, Envoy के लिए Remote Service की बाइंडिंग हटाएं.

इस्तेमाल

Edge Public Cloud के लिए:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Edge Private Cloud के लिए:

apigee-remote-service-cli bindings remove [service_name] [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

कहां:

  • target_name, रिमोट सेवा का नाम है. इसे प्रॉडक्ट से अनबाइंड करना है.
  • product_name उस प्रॉडक्ट का नाम है जिससे टारगेट को अनबाइंड करना है.

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, कमांड के ज़्यादातर पैरामीटर हटाए जा सकते हैं. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. --config विकल्प का इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का कोई एनवायरमेंट.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
--insecure एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन की अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें. यह Edge Cloud के लिए मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee का कई चरणों में पुष्टि करने वाला टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर Apigee Edge for Private Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) Apigee संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-p, --password स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड देने का विकल्प होता है. ऐसा करने पर, आपको कमांड लाइन पर अपना पासवर्ड देने की ज़रूरत नहीं होती. यह भी देखें क्रेडेंशियल के लिए .netrc का इस्तेमाल करना.
-r, --runtime स्ट्रिंग (सिर्फ़ Private Cloud के लिए) इससे आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल के बारे में पता चलता है.
-t, --token स्ट्रिंग (सिर्फ़ OAuth टोकन की पुष्टि के लिए ज़रूरी है) एक OAuth या SAML टोकन, जिसे आपने Apigee खाते की जानकारी से जनरेट किया है. टोकन जनरेट करने के बारे में जानकारी के लिए, get_token का इस्तेमाल करना और एसएएमएल की मदद से मैनेजमेंट एपीआई को ऐक्सेस करना लेख पढ़ें.
-u, --username स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है) आपका Apigee उपयोगकर्ता नाम. आम तौर पर, यह एक ईमेल पता होता है. .netrc फ़ाइल में, उपयोगकर्ता नाम की जानकारी देना ज़रूरी नहीं है. ऐसा करने पर, आपको कमांड लाइन पर अपना उपयोगकर्ता नाम देने की ज़रूरत नहीं होती. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-v, --verbose (ज़रूरी नहीं) इससे वर्बोस आउटपुट मिलता है.

उदाहरण

./apigee-remote-service-cli bindings remove httpbin.org envoy-test -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
product envoy-test is no longer bound to: httpbin.org

बाइंडिंग की पुष्टि करना

पुष्टि करें कि तय किए गए बाउंड एपीआई प्रॉडक्ट और उससे जुड़े डेवलपर ऐप्लिकेशन में, रिमोट सेवा वाला प्रॉडक्ट भी जुड़ा हो. अगर एपीआई प्रॉडक्ट का नाम नहीं दिया जाता है, तो कमांड, बाइंड किए गए सभी प्रॉडक्ट की जांच करती है.

इस्तेमाल

Edge Public Cloud के लिए:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -c [config]

Edge Private Cloud के लिए:

apigee-remote-service-cli bindings verify [product_name]  -o [organization] -e [environment] -u [username] -p [password] -r [runtime] -c [config]

यहां प्रॉडक्ट का नाम देना ज़रूरी नहीं है. प्रॉडक्ट का नाम नहीं बताने पर, लिंक किए गए सभी प्रॉडक्ट की जांच की जाती है.

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, कमांड के ज़्यादातर पैरामीटर हटाए जा सकते हैं. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. --config विकल्प का इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का कोई एनवायरमेंट.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
--insecure एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन की अनुमति दें
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें. यह Edge Cloud के लिए मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee का कई चरणों में पुष्टि करने वाला टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
--opdk अगर Apigee Edge for Private Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें.
-o, --org स्ट्रिंग (ज़रूरी है) Apigee संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-r, --runtime स्ट्रिंग (सिर्फ़ Private Cloud के लिए) इससे आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल के बारे में पता चलता है.
-t, --token स्ट्रिंग (सिर्फ़ OAuth टोकन की पुष्टि के लिए ज़रूरी है) एक OAuth या SAML टोकन, जिसे आपने Apigee खाते की जानकारी से जनरेट किया है. टोकन जनरेट करने के बारे में जानकारी के लिए, get_token का इस्तेमाल करना और एसएएमएल की मदद से मैनेजमेंट एपीआई को ऐक्सेस करना लेख पढ़ें.
-v, --verbose (ज़रूरी नहीं) इससे वर्बोस आउटपुट मिलता है.

उदाहरण

./apigee-remote-service-cli bindings verify my-product -o myorg -e test -u user@example.com -c config.yaml -p xxxxxx
  app my-app associated with product my-product is verified

सहायता के लिए निर्देश

सभी apigee-remote-service-cli कमांड के लिए ऑनलाइन सहायता उपलब्ध है. सिर्फ़ यह टाइप करें:

apigee-remote-service-cli help

किसी भी निर्देश के बारे में मदद पाने के लिए, यह टाइप करें:

apigee-remote-service-cli [command] help

उदाहरण के लिए:

apigee-remote-service-cli provision help

प्रॉविज़न करने का निर्देश

apigee-remote-service-cli provision कमांड, आपके Apigee Edge संगठन में एक प्रॉक्सी इंस्टॉल करती है, एक सर्टिफ़िकेट सेट अप करती है, और क्रेडेंशियल जनरेट करती है. इन क्रेडेंशियल का इस्तेमाल, Apigee Adapter for Envoy को कॉन्फ़िगर करने के लिए किया जाता है.

इस्तेमाल

अगर Edge Public Cloud का इस्तेमाल किया जा रहा है, तो:

apigee-remote-service-cli provision -o $ORG -e $ENV -u $USERNAME -p $PASSWORD

अगर Edge Private Cloud का इस्तेमाल किया जा रहा है, तो:

apigee-remote-service-cli provision --opdk -o $ORG -e $ENV -u $USERNAME --management $MGMT_SERVER_URL --runtime $RUNTIME_URL -p $PASSWORD

पैरामीटर

पैरामीटर टाइप ब्यौरा
--analytics-sa स्ट्रिंग यह फ़्लैग सिर्फ़ Apigee hybrid और Apigee on Google Cloud इंस्टॉलेशन के लिए उपलब्ध है.

इस फ़्लैग का इस्तेमाल करके, Google Cloud सेवा खाते की कुंजी फ़ाइल का पाथ तय करें. इस फ़ाइल में, सेवा खाते के पास Apigee Analytics Agent की भूमिका होती है. SA का इस्तेमाल, अडैप्टर करता है. इससे वह सीधे तौर पर Apigee पर Analytics डेटा अपलोड कर पाता है. Apigee hybrid का इस्तेमाल करने पर, इस विकल्प की मदद से, हाइब्रिड रनटाइम को एक क्लस्टर में और अडैप्टर को दूसरे क्लस्टर में इंस्टॉल किया जा सकता है.

-c, --config स्ट्रिंग Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ. --config विकल्प का इस्तेमाल करना लेख भी पढ़ें.
-e, --environment स्ट्रिंग (ज़रूरी है) आपके संगठन का कोई एनवायरमेंट.
-f, --force-proxy-install (ज़रूरी नहीं) अगर आपके संगठन में remote-service प्रॉक्सी पहले से इंस्टॉल है, तो इसे फिर से इंस्टॉल करने के लिए मजबूर करता है.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
-k, --key स्ट्रिंग इससे apigee-remote-service-cli provision कमांड से मिली कुंजी के बारे में पता चलता है.
--legacy अगर Apigee Edge Cloud का इस्तेमाल किया जा रहा है, तो इस फ़्लैग को सेट करें. यह Edge Cloud के लिए मैनेजमेंट और रनटाइम यूआरएल सेट करता है.
--mfa Apigee का कई चरणों में पुष्टि करने वाला टोकन (सिर्फ़ --legacy के साथ इस्तेमाल किया जाता है)
-m, --management स्ट्रिंग (अगर Apigee Private Cloud का इस्तेमाल किया जा रहा है, तो यह ज़रूरी है) Apigee मैनेजमेंट का बेस यूआरएल. डिफ़ॉल्ट: https://api.enterprise.apigee.com
-n, --namespace स्ट्रिंग कॉन्फ़िगरेशन को, तय किए गए नेमस्पेस में Envoy ConfigMap के तौर पर दिखाता है. डिफ़ॉल्ट: apigee
--opdk स्ट्रिंग Apigee OPDK.
-o, --organization स्ट्रिंग (ज़रूरी है) आपका Apigee संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-p, --password स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है) आपका Apigee पासवर्ड. आपके पास .netrc फ़ाइल में पासवर्ड देने का विकल्प होता है. ऐसा करने पर, आपको कमांड लाइन पर अपना पासवर्ड देने की ज़रूरत नहीं होती. यह भी देखें क्रेडेंशियल के लिए .netrc का इस्तेमाल करना.
--rotate-int int अगर n > 0 है, तो नई निजी कुंजी जनरेट करें और n सार्वजनिक कुंजियां रखें (सिर्फ़ हाइब्रिड के लिए)
-r, --runtime स्ट्रिंग (सिर्फ़ Private Cloud के लिए) इससे आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल के बारे में पता चलता है.
-s, --secret स्ट्रिंग इससे apigee-remote-service-cli provision कमांड से मिले सीक्रेट के बारे में पता चलता है.
--strength int (ज़रूरी नहीं) यह विकल्प, अडैप्टर को चालू करने के लिए इस्तेमाल किए गए एसएसएल सर्टिफ़िकेट के लिए एन्क्रिप्शन की मज़बूती तय करता है. डिफ़ॉल्ट 2048
-t, --token स्ट्रिंग (सिर्फ़ हाइब्रिड के लिए) Apigee OAuth या SAML टोकन.
-u, --username स्ट्रिंग (सिर्फ़ बुनियादी पुष्टि के लिए ज़रूरी है) आपका Apigee उपयोगकर्ता नाम. आम तौर पर, यह एक ईमेल पता होता है. .netrc फ़ाइल में, उपयोगकर्ता नाम की जानकारी देना ज़रूरी नहीं है. क्रेडेंशियल के लिए .netrc का इस्तेमाल करना भी देखें.
-v, --verbose (ज़रूरी नहीं) इससे वर्बोस आउटपुट मिलता है.
--virtual-hosts स्ट्रिंग यह डिफ़ॉल्ट वर्चुअल होस्ट को बदलता है. डिफ़ॉल्ट वर्चुअल होस्ट default,secure होते हैं. अगर आपके Edge संगठन-एनवायरमेंट के लिए, इन डिफ़ॉल्ट के अलावा अन्य वर्चुअल होस्ट तय किए गए हैं, तो इस विकल्प का इस्तेमाल करें. वर्चुअल होस्ट के बारे में जानने के लिए, Edge का दस्तावेज़ देखें.
--years int (ज़रूरी नहीं) यह संख्या, सेट अप में इस्तेमाल किए गए एसएसएल सर्टिफ़िकेट की समयसीमा खत्म होने से पहले के सालों की संख्या होती है. डिफ़ॉल्ट: 1

उदाहरण

provision कमांड के आउटपुट को किसी फ़ाइल में सेव करना न भूलें. इसका इस्तेमाल, Apigee Adapter for Envoy की अन्य कार्रवाइयों के लिए इनपुट के तौर पर किया जाता है.

Edge Public Cloud का उदाहरण:

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

सैंपल कमांड

यह टूल, नेटिव Envoy या Istio डिप्लॉयमेंट के लिए सैंपल कॉन्फ़िगरेशन फ़ाइलें बनाता है.

इस्तेमाल

apigee-remote-service-cli samples create [flags]

ब्यौरा

इस कमांड के लिए, प्रोविज़निंग के ज़रिए जनरेट की गई मान्य config.yaml फ़ाइल ज़रूरी है. डिफ़ॉल्ट रूप से, सैंपल फ़ाइलें ./samples नाम की डायरेक्ट्री में सेव होती हैं. यह कमांड, आपके लिए यह डायरेक्ट्री बनाती है.

अगर नेटिव Envoy का इस्तेमाल किया जा रहा है, तो कमांड में टारगेट सर्विस होस्ट और उसके क्लस्टर के लिए मनचाहा नाम डालें. अगर --tls के ज़रिए tls.key और tls.crt वाला फ़ोल्डर उपलब्ध कराया जाता है, तो यह Envoy प्रॉक्सी से रिमोट सर्विस क्लस्टर तक कस्टम एसएसएल कनेक्शन भी सेट करता है.

अगर Istio का इस्तेमाल किया जा रहा है, जहां Envoy प्रॉक्सी साइडकार के तौर पर काम करती है, तो टारगेट की जानकारी न देने पर, httpbin उदाहरण जनरेट होगा. इसके अलावा, टारगेट की गई सेवाओं को डिप्लॉय करने से जुड़ी कॉन्फ़िगरेशन फ़ाइलें तैयार करने की ज़िम्मेदारी आपकी है.

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, कमांड के ज़्यादातर पैरामीटर हटाए जा सकते हैं. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. --config विकल्प का इस्तेमाल करना देखें.
-f, --force मौजूदा डायरेक्ट्री को ओवरराइट करने के लिए मजबूर करें.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
--host टारगेट सेवा का होस्ट (डिफ़ॉल्ट रूप से "httpbin.org")
-n, --name टारगेट सेवा का नाम (डिफ़ॉल्ट रूप से "httpbin")
--out वह डायरेक्ट्री जिसमें सैंपल कॉन्फ़िगरेशन फ़ाइलें बनानी हैं. डिफ़ॉल्ट: ./samples
-t, --template

टेंप्लेट का नाम. अगर आपको Istio डिप्लॉयमेंट (सिर्फ़ हाइब्रिड) करना है, तो उपलब्ध Istio विकल्पों में से कोई एक चुनें. Envoy के नेटिव डिप्लॉयमेंट के लिए, नेटिव विकल्प का इस्तेमाल करें. ये विकल्प उपलब्ध हैं:

  • istio-1.6 (डिफ़ॉल्ट)
  • istio-1.7
  • native
--tls वह डायरेक्ट्री जिसमें TLS कुंजी और crt फ़ाइलों को सेव करना है.

उदाहरण

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

टोकन कमांड

एपीआई पासकोड का इस्तेमाल करने के बजाय, पुष्टि किए गए एपीआई प्रॉक्सी कॉल करने के लिए, JWT टोकन का इस्तेमाल किया जा सकता है. टोकन कमांड की मदद से, इस मकसद के लिए JWT टोकन बनाए, उनकी जांच की जा सकती है, और उन्हें रोटेट किया जा सकता है.

JWT टोकन बनाना

रिमोट सेवा के टारगेट पर पुष्टि की गई एपीआई प्रॉक्सी कॉल करने के लिए, JWT टोकन का इस्तेमाल किया जा सकता है. JWT पर आधारित पुष्टि करने की सुविधा का इस्तेमाल करना भी देखें.

इस्तेमाल

Edge Public Cloud के लिए:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -o [org] -e [env]
Edge Private Cloud के लिए:
apigee-remote-service-cli token create -c [config_file] --id [consumer_key] --secret [consumer_secret] -r [runtime] -o [org] -e [env]

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, कमांड के ज़्यादातर पैरामीटर हटाए जा सकते हैं. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. --config विकल्प का इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का कोई एनवायरमेंट.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
--insecure एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन की अनुमति दें.
-o, --org स्ट्रिंग (ज़रूरी है) Apigee संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-r, --runtime स्ट्रिंग (सिर्फ़ Private Cloud के लिए) इससे आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल के बारे में पता चलता है.
-v, --verbose (ज़रूरी नहीं) इससे वर्बोस आउटपुट मिलता है.

उदाहरण

apigee-remote-service-cli token create -o myorg -e test -i YUmlZAcBKNsTAelJqPZFl3sh58ObATX9 -s icTARgaKHqvUH1dq -c config.yaml

आउटपुट

सर्टिफ़िकेट की पुष्टि हो जाने पर, आपको JST टोकन का आउटपुट दिखेगा. यह कुछ ऐसा होगा:
eyJraWQiOiIxIiwidHlwIjoiSldUIiwiYWxnIjoiUlMyNTYifQ.eyJhY2Nlc3NfdG9rZW4iOiJ0a2tlVzVKQTY2a0pZYTB4bFV1cVBsUW1BMU43IiwiYXVkIjoiaXN0aW8iLCJuYmYiOjE1MzAxMzg1OTEsImFwaV9wcm9kdWN0X2xpc3QiOlsiaXN0aW8tcHJvZHVjdCJdLCJhcHBsaWNhdGlvbl9uYW1lIjoiaXN0aW8tYXBwIiwiZGV2ZWxvcGVyX2VtYWlsIjoicFluZ2Zsb3lkQGdvb2dsZS5jb20iLCJpc3MiOiJodHRwczovL2FwaWdlZXNlYXJjaC10ZXN0LmFwaWdlZS5uZXQvaXN0aW8tYXV0aC90b2tlbiIsImV4cCI6MTUzMDEzOTQ5MSwiaWF0IjoxNTMwMTM4NTkxLCJqdGkiOiIxODgzMzViZi0wMmE4LTRjZGUsOGFkOS0yMWJmNDZjNmRjZDkiLCJjbGllbnRfaWQiOiJZVW1sWkFjQktOc1RBZWxKcVBZRmwzc2g1OE9iQVRYOSJ9.AL7pKSTmond-NSPRNNHVbIzTdAnZjOXcjQ-BbOJ_8lsQvF7PuiOUrGIhY5XTcJusisKgbCdtIxBl8Wq1EiQ_fKnUc3JYYOqzpTB5bGoFy0Yqbfu96dneuWyzgZnoQBkqwZkbQTIg7WNTGx1TJX-UTePvBPxAefiAbaEUcigX9tTsXPoRJZOTrm7IOeKpxpB_gQYkxQtV1_NbERxjTPyMbHdMWal9_xRVzSt7mpTGudMN9OR-VtQ1uXA67GOqhZWcOzq57qImOiCMbaoKnKUADevyWjX_VscN5ZZUtzQUQhTrmv8aR69-uVhMIPKp9juMyYKaYn2IsYZEeCWfhfV45Q

JWT टोकन की जांच करना

इस निर्देश की मदद से, JWT टोकन की जांच की जा सकती है. टोकन की जांच करना लेख भी पढ़ें.

इस्तेमाल

Edge Public Cloud के लिए:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file]
Edge Private Cloud के लिए:
apigee-remote-service-cli token inspect -o [organization] -e [environment] -f [token_file] --runtime [host_alias]

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, कमांड के ज़्यादातर पैरामीटर हटाए जा सकते हैं. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. --config विकल्प का इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का कोई एनवायरमेंट.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
--insecure एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन की अनुमति दें.
-o, --org स्ट्रिंग (ज़रूरी है) Apigee संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-r, --runtime स्ट्रिंग (सिर्फ़ Private Cloud के लिए) इससे आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल के बारे में पता चलता है.
-v, --verbose (ज़रूरी नहीं) इससे वर्बोस आउटपुट मिलता है.

उदाहरण

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

आउटपुट

सफल होने पर, आपको इससे मिलता-जुलता आउटपुट दिखेगा:
{
	"aud": [
		"remote-service-client"
	],
	"exp": 1591741549,
	"iat": 1591740649,
	"iss": "https://apigee-docs-test.apigee.net/remote-service/token",
	"jti": "99325d2e-6440-4278-9f7f-b252a1a79e53",
	"nbf": 1591740649,
	"access_token": "VfzpXzBGAQ07po0bPMKY4JgQjus",
	"api_product_list": [
		"httpbin"
	],
	"application_name": "httpbin",
	"client_id": "GYDGHy5TRpV8AejXCOlreP7dPVepA8H",
	"developer_email": "user@example.com",
	"scope": ""
}
verifying...
token ok.

JWT टोकन को रोटेट करना

शुरुआत में JWT जनरेट करने के कुछ समय बाद, आपको Apigee Edge में सेव किए गए सार्वजनिक/निजी पासकोड के जोड़े को बदलना पड़ सकता है. यह जोड़ा, Apigee Edge के एन्क्रिप्ट (सुरक्षित) किए गए की-वैल्यू मैप (केवीएम) में सेव होता है. नई कुंजी का जोड़ा जनरेट करने की इस प्रोसेस को कुंजी रोटेशन कहा जाता है. पासकोड रोटेट करने पर, निजी/सार्वजनिक पासकोड का नया जोड़ा जनरेट होता है. इसे आपके Apigee Edge संगठन/एनवायरमेंट में "istio" KVM में सेव किया जाता है. इसके अलावा, पुरानी सार्वजनिक कुंजी को उसकी मूल कुंजी आईडी वैल्यू के साथ सेव करके रखा जाता है.

इस्तेमाल

अगर Edge Public Cloud का इस्तेमाल किया जा रहा है, तो:
apigee-remote-service-cli token rotate-cert -c [config_file] -o [organization] -e [environment] -k [provision_key] -s [provision_secret] --kid [new_key_id]
अगर Edge Private Cloud का इस्तेमाल किया जा रहा है, तो:
apigee-remote-service-cli token rotate-cert -o [organization] -e [environment] -u [username] -p [password] -k [provision_key] -s [provision_secret] --kid [new_key_id]

पैरामीटर

पैरामीटर टाइप ब्यौरा
-c, --config स्ट्रिंग (ज़रूरी है) Apigee Remote Service की कॉन्फ़िगरेशन फ़ाइल का पाथ.
अहम जानकारी: इस फ़्लैग की मदद से, कमांड के ज़्यादातर पैरामीटर हटाए जा सकते हैं. ऐसा इसलिए, क्योंकि सीएलआई उन्हें सीधे कॉन्फ़िगरेशन फ़ाइल से खींच सकता है. --config विकल्प का इस्तेमाल करना देखें.
-e, --env स्ट्रिंग (ज़रूरी है) आपके संगठन का कोई एनवायरमेंट.
-h, --help यह कमांड पैरामीटर के बारे में जानकारी दिखाता है.
--insecure एसएसएल का इस्तेमाल करते समय, असुरक्षित सर्वर कनेक्शन की अनुमति दें
--truncate int jwks में रखे जाने वाले सर्टिफ़िकेट की संख्या (डिफ़ॉल्ट रूप से 2)
-o, --org स्ट्रिंग (ज़रूरी है) Apigee संगठन. आपके पास संगठन के एडमिन की भूमिका होनी चाहिए.
-r, --runtime स्ट्रिंग (सिर्फ़ Private Cloud के लिए) इससे आपके Private Cloud इंस्टेंस के लिए रनटाइम यूआरएल के बारे में पता चलता है.
-v, --verbose (ज़रूरी नहीं) इससे वर्बोस आउटपुट मिलता है.

उदाहरण

apigee-remote-service-cli token rotate-cert -c config.yaml -o myorg -e test -k 2e238ffa15dc5ab6a1e97868e7581f6c60ddb8575478582c256d8b7e5b2677a8 -s 51058077223fa7b683c3bea845c5cca138340d1d5583922b6d465f9f918a4b08

आउटपुट

certificate successfully rotated

क्रेडेंशियल के लिए .netrc का इस्तेमाल करना

अगर Edge Public Cloud का इस्तेमाल किया जा रहा है और मशीन api.enterprise.apigee.com के लिए कोई एंट्री मौजूद है, तो apigee-remote-service-cli आपकी होम डायरेक्ट्री में मौजूद .netrc फ़ाइल से username और password (ज़रूरत पड़ने पर बुनियादी पुष्टि के लिए) अपने-आप चुन लेता है. अगर Apigee Private Cloud का इस्तेमाल किया जा रहा है, तो मशीन की वैल्यू, आपके management यूआरएल (उदाहरण के लिए: http://192.162.55.100) के बराबर होती है. उदाहरण के लिए, Edge Public Cloud पर:
machine api.enterprise.apigee.com
login jdoe@google.com
password abc123
उदाहरण के लिए, Edge Private Cloud पर:
machine http://192.162.55.100
login jdoe@google.com
password abc123

वर्शन कमांड

सीएलआई वर्शन प्रिंट करें.

apigee-remote-service-cli version

--config कमांड विकल्प का इस्तेमाल करना

--config विकल्प, provision कमांड से जनरेट हुई कॉन्फ़िगरेशन फ़ाइल की जगह की जानकारी देता है. इस विकल्प का एक फ़ायदा यह है कि इससे आपको ज़्यादातर कमांड पैरामीटर छोड़ने की अनुमति मिलती है. सीएलआई, कॉन्फ़िगरेशन फ़ाइल से इन पैरामीटर को खींचता है. इन विकल्पों में ये शामिल हैं:
  • संगठन
  • वातावरण
  • रनटाइम
  • मैनेजमेंट
  • असुरक्षित
  • नेमस्पेस
  • लेगसी
  • opdk

उदाहरण के लिए, provision कमांड को इस तरह से लागू किया जा सकता है:

apigee-remote-service-cli provision --config='old-config.yaml' > new-config.yaml

कॉन्फ़िगरेशन फ़ाइल

इस सेक्शन में, उपलब्ध सभी विकल्पों के साथ कॉन्फ़िगरेशन फ़ाइल का उदाहरण दिखाया गया है.

global:
  temp_dir: /tmp/apigee-istio
  keep_alive_max_connection_age: 10m
  api_address: :5000
  metrics_address: :5001
  tls:
    cert_file: tls.crt
    key_file: tls.key
tenant:
  internal_api: https://istioservices.apigee.net/edgemicro
  remote_service_api: https://org-test.apigee.net/remote-service
  org_name: org
  env_name: env
  key: mykey
  secret: mysecret
  client_timeout: 30s
  allow_unverified_ssl_cert: false
products:
  refresh_rate: 2m
analytics:
  legacy_endpoint: false
  file_limit: 1024
  send_channel_size: 10
  collection_interval: 10s
  fluentd_endpoint: apigee-udca-myorg-test.apigee.svc.cluster.local:20001
  tls:
    ca_file: /opt/apigee/tls/ca.crt
    cert_file: /opt/apigee/tls/tls.crt
    key_file: /opt/apigee/tls/tls.key
    allow_unverified_ssl_cert: false
auth:
  api_key_claim: claim
  api_key_cache_duration: 30m
  api_key_header: x-api-key
  api_target_header: :authority
  reject_unauthorized: true
  jwks_poll_interval: 0s