Edge for Private Cloud v. 4.17.05
Edge कॉन्फ़िगरेशन के उन ही टास्क को पूरा करने के लिए, apigee-adminapi.sh सुविधा का इस्तेमाल करें जिन्हें Edge मैनेजमेंट एपीआई को कॉल करके पूरा किया जाता है. apigee-adminapi.sh की सुविधा का फ़ायदा यह है कि यह:
- आसान कमांड-लाइन इंटरफ़ेस का इस्तेमाल करना
- टैब का इस्तेमाल करके कमांड पूरा करने की सुविधा लागू की गई
- सहायता और इस्तेमाल से जुड़ी जानकारी देता है
- अगर आपको एपीआई आज़माना है, तो उससे जुड़ा एपीआई कॉल दिखाया जा सकता है
apigee-adminapi.sh टूल, apigee-provision टूल की जगह इस्तेमाल नहीं किया जा सकता. apigee-provision टूल, अपने काम करने के लिए apigee-adminapi.sh टूल का इस्तेमाल करता है.
इन दोनों के बीच मुख्य अंतर ये हैं:
- apigee-adminapi.sh टूल, एटमिक फ़ंक्शन करता है. ये फ़ंक्शन, अलग-अलग Edge API कॉल की जगह लेते हैं. उदाहरण के लिए, किसी संगठन, एनवायरमेंट, और वर्चुअल होस्ट को बनाने के लिए, तीन एपीआई कॉल से जुड़े तीन अलग-अलग apigee-adminapi.sh निर्देशों की ज़रूरत होती है.
- apigee-provision उपयोगिता को एक ही निर्देश में पूरा हाई-लेवल ऑपरेशन करने के लिए डिज़ाइन किया गया है. उदाहरण के लिए, apigee-provision कमांड की मदद से, एक ही कमांड में संगठन, एनवायरमेंट, और वर्चुअल होस्ट बनाया जा सकता है. इसके लिए, सभी ज़रूरी जानकारी वाली कॉन्फ़िगरेशन फ़ाइल को पास करना होगा.
Edge के दस्तावेज़ में, ज़रूरत के हिसाब से दोनों सुविधाओं का इस्तेमाल किया जाता है.
apigee-adminapi.sh इंस्टॉल करना
apigee-provision या apigee-validate टूल इंस्टॉल करने पर, apigee-adminapi.sh टूल अपने-आप इंस्टॉल हो जाता है.
यह सुविधा यहां इंस्टॉल की गई है:
/opt/apigee/apigee-adminapi/bin/apigee-adminapi.sh
apigee-adminapi.sh सिंटैक्स
apigee-adminapi.sh टूल, कमांड लाइन सिंटैक्स का इस्तेमाल करता है. किसी भी समय, टैब बटन का इस्तेमाल करके, निर्देश के उपलब्ध विकल्पों की सूची वाला प्रॉम्प्ट दिखाएं.
सभी संभावित निर्देश देखने के लिए, बिना किसी विकल्प के इस सुविधा को चालू करें:
> apigee-adminapi.sh
apigee-adminapi.sh टाइप करने के बाद Tab दबाने पर, आपको संभावित विकल्पों की सूची दिखेगी:
analytics classification logsessions regions securityprofile userroles buildinfo GET orgs runtime servers users
Tab बटन, निर्देश के संदर्भ के आधार पर विकल्प दिखाता है. अगर टाइप करने के बाद, Tab दबाया जाता है, तो:
> apigee-adminapi.sh orgs
आपको orgs कमांड को पूरा करने के लिए, ये विकल्प दिखेंगे:
add apis apps delete envs list pods userroles
किसी भी कमांड के लिए मदद पाने के लिए, -h विकल्प का इस्तेमाल करें. उदाहरण के लिए, अगर -h विकल्प का इस्तेमाल नीचे दिखाए गए तरीके से किया जाता है, तो:
> apigee-adminapi.sh orgs -h
यह सुविधा, orgs कमांड के सभी संभावित विकल्पों के लिए, सहायता से जुड़ी पूरी जानकारी दिखाती है. आउटपुट में पहला आइटम, "orgs add" कमांड के लिए मदद दिखाता है:
+++++++++++++++++++++++++++++++++++++++++++
orgs add
Required:
-o ORG Organization name
Optional:
-H HEADER add http header in request
--admin ADMIN_EMAIL admin email address
--pwd ADMIN_PASSWORD admin password
--host EDGE_SERVER edge server to make request to
--port EDGE_PORT port to use for the http request
--ssl set EDGE_PROTO to https, defaults to http
--debug ( set in debug mode, turns on verbose in curl )
-h Displays Help
कमांड-लाइन स्विच और एनवायरमेंट वैरिएबल का इस्तेमाल करके पैरामीटर सेट करना
आपको कमांड-लाइन स्विच या फिर एनवायरमेंट वैरिएबल का इस्तेमाल करके, किसी कमांड में सभी पैरामीटर डालने होंगे. ज़रूरत के हिसाब से, कमांड लाइन स्विच के आगे एक डैश (-) या दो डैश (--) लगाएं.
उदाहरण के लिए, "orgs add" कमांड के लिए ऊपर दी गई सहायता से, संगठन का नाम बताने के लिए, इनमें से कोई एक तरीका अपनाएं:
- -o कमांड लाइन का इस्तेमाल करके,
स्विच करें:
> apigee-adminapi.sh orgs -o testOrg - ORG नाम का एनवायरमेंट वैरिएबल सेट करना:
> export ORG=testOrg
> apigee-adminapi.sh orgs
अगर आपने कमांड में कोई ज़रूरी पैरामीटर शामिल नहीं किया है, तो यह सुविधा गड़बड़ी का मैसेज दिखाती है. उदाहरण के लिए, अगर संगठन बनाते समय, Edge मैनेजमेंट सर्वर की जानकारी देने वाले --host या EDGE_SERVER एनवायरमेंट वैरिएबल को शामिल नहीं किया जाता है, तो आपको गड़बड़ी का यह मैसेज दिखता है:
Error with required variable or parameter ADMIN_PASSWORD....OK ADMIN_EMAIL....OK EDGE_SERVER....null
आम तौर पर, दो सामान्य पैरामीटर को एनवायरमेंट वैरिएबल के तौर पर सेट किया जाता है. ये पैरामीटर, मैनेजमेंट सर्वर का आईपी पता और सिस्टम एडमिन का ईमेल पता होते हैं:
> export ADMIN_EMAIL=foo@bar.com > export EDGE_SERVER=192.168.56.101
apigee-adminapi.sh उपयोगिता को कोई फ़ाइल पास करना
apigee-adminapi.sh की कुछ सुविधाओं के कमांड, अनुरोध बॉडी वाले PUT और POST एपीआई कॉल से जुड़े होते हैं. उदाहरण के लिए, वर्चुअल होस्ट बनाना, पोस्ट एपीआई कॉल से जुड़ा होता है. इसके लिए, अनुरोध के मुख्य हिस्से में वर्चुअल होस्ट की जानकारी ज़रूरी होती है.
वर्चुअल होस्ट बनाने या अनुरोध बॉडी लेने वाले किसी भी कमांड के लिए, apigee-adminapi.sh सुविधा का इस्तेमाल करते समय, कमांड लाइन पर सभी ज़रूरी जानकारी दी जा सकती है. इसके लिए, नीचे दिया गया तरीका अपनाएं:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -v myVHostUtil -p 9005 -a 192.168.56.101:9005
इसके अलावा, ऐसी फ़ाइल भी पास की जा सकती है जिसमें वही जानकारी हो जो POST के अनुरोध बॉडी में होती है. उदाहरण के लिए, यह कमांड वर्चुअल होस्ट की जानकारी देने वाली फ़ाइल लेता है:
> apigee-adminapi.sh orgs envs virtual_hosts add -e prod -o testOrg --host localhost --admin foo@bar.com -f vhostcreate
जहां vhostcreate फ़ाइल में, कॉल का POST बॉडी शामिल होता है. इस उदाहरण में, यह एक्सएमएल फ़ॉर्मैट में अनुरोध का मुख्य हिस्सा है:
<VirtualHost name="myVHostUtil">
<HostAliases>
<HostAlias>192.168.56.101:9005</HostAlias>
</HostAliases>
<Interfaces/>
<Port>9005</Port>
</VirtualHost>
डीबग और एपीआई की जानकारी दिखाना
कमांड के बारे में पूरी जानकारी दिखाने के लिए, apigee-adminapi.sh टूल के साथ --debug विकल्प का इस्तेमाल करें. इस जानकारी में, apigee-adminapi.sh टूल से जनरेट किया गया cURL कमांड शामिल होता है.
उदाहरण के लिए, यह कमांड --debug विकल्प का इस्तेमाल करता है:
> apigee-adminapi.sh orgs add -o testOrg2 --admin foo@bar.com --host localhost --debug
साथ ही, जनरेट किए गए cURL कमांड के साथ यह आउटपुट दिखाता है:
curl -H Content-Type: application/xml -v -X POST -s -k -w \n==> %{http_code}
-u ***oo@bar.com:***** http://localhost:8080/v1/o -d <Organization name="testOrg2"
type="paid"/>
* About to connect() to localhost port 8080 (#0)
* Trying ::1... connected
* Connected to localhost (::1) port 8080 (#0)
* Server auth using Basic with user 'foo@bar.com'
> POST /v1/o HTTP/1.1
> Authorization: Basic c2dp234234NvbkBhcGlnZ2342342342342341Q5
> User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.19.1
Basic ECC zlib/1.2.3 libidn/1.18 libssh2/1.4.2
> Host: localhost:8080
> Accept: */*
> Content-Type: application/xml
> Content-Length: 43
>
} [data not shown]
< HTTP/1.1 201 Created
< Content-Type: application/json
< Date: Tue, 03 May 2016 02:08:32 GMT
< Content-Length: 291
<
{ [data not shown]
* Connection #0 to host localhost left intact
* Closing connection #0