Edge को कॉन्फ़िगर करने का तरीका

Edge for Private Cloud का वर्शन 4.18.05

इंस्टॉल करने के बाद Edge को कॉन्फ़िगर करने के लिए, .properties फ़ाइलों और Edge की सुविधाओं का इस्तेमाल किया जाता है. उदाहरण के लिए, Edge यूज़र इंटरफ़ेस (यूआई) पर टीएलएस/एसएसएल को कॉन्फ़िगर करने के लिए, ज़रूरी प्रॉपर्टी सेट करने के लिए .properties फ़ाइलों में बदलाव किया जाता है. .properties फ़ाइलों में किए गए बदलावों को लागू करने के लिए, आपको Edge के उस कॉम्पोनेंट को रीस्टार्ट करना होगा जिसमें बदलाव किए गए हैं.

Apigee, .properties फ़ाइलों में बदलाव करने की तकनीक को कॉन्फ़िगरेशन के साथ कोड के तौर पर दिखाता है. कॉन्फ़िगरेशन वाला कोड, मुख्य रूप से .properties फ़ाइलों की सेटिंग पर आधारित एक की/वैल्यू लुकअप टूल है. कॉन्फ़िगरेशन वाले कोड में, कुंजियों को टोकन कहा जाता है. इसलिए, Edge को कॉन्फ़िगर करने के लिए, आपको .properties फ़ाइलों में टोकन सेट करने होंगे.

कॉन्फ़िगरेशन वाले कोड की मदद से, Edge कॉम्पोनेंट के लिए डिफ़ॉल्ट वैल्यू सेट की जा सकती हैं. ये वैल्यू, प्रॉडक्ट के साथ शिप की जाती हैं. साथ ही, इंस्टॉलेशन टीम को इंस्टॉलेशन टोपोलॉजी के आधार पर उन सेटिंग को बदलने की अनुमति मिलती है. इसके बाद, ग्राहक अपनी पसंद के मुताबिक किसी भी प्रॉपर्टी को बदल सकते हैं.

अगर इसे हैरारकी के तौर पर देखा जाए, तो सेटिंग को इस तरह से व्यवस्थित किया जाता है. इसमें ग्राहक की सेटिंग को सबसे ज़्यादा प्राथमिकता दी जाती है, ताकि इंस्टॉलर टीम या Apigee की किसी भी सेटिंग को बदला जा सके:

1. ग्राहक
2. इंस्टॉलर
3. Apigee

.properties फ़ाइलों को इस्तेमाल करने का तरीका

ग्राहक के तौर पर, आपके पास सिर्फ़ /opt/apigee/customer/application डायरेक्ट्री में मौजूद .properties फ़ाइलों में बदलाव करने का विकल्प होता है. हर कॉम्पोनेंट की अपनी .properties फ़ाइल उस डायरेक्ट्री में होती है. उदाहरण के लिए, router.properties और management-server.properties.

उदाहरण के लिए, .properties फ़ाइल बनाने के लिए:

1. किसी भी उपयोगकर्ता के तौर पर, एडिटर में फ़ाइल बनाएं.
2. फ़ाइल के मालिक को "apigee:apigee" में बदलने के लिए, chown का इस्तेमाल करें. इसके अलावा, अगर आपने Edge सेवा को "apigee" उपयोगकर्ता से चलाने वाले उपयोगकर्ता को बदल दिया है, तो Edge सेवा को चलाने वाले उपयोगकर्ता को फ़ाइल का मालिकाना हक दें.

किसी कॉम्पोनेंट के लिए प्रॉपर्टी सेट करने के लिए, उससे जुड़ी .properties फ़ाइल में बदलाव करके टोकन सेट करें. इसके बाद, कॉम्पोनेंट को रीस्टार्ट करें:

/opt/apigee/apigee-service/bin/apigee-service component restart

उदाहरण के लिए, router.properties में बदलाव करने के बाद, राऊटर को रीस्टार्ट करें:

/opt/apigee/apigee-service/bin/apigee-service edge-router restart

Edge को अपग्रेड करने पर, /opt/apigee/customer/application डायरेक्ट्री में मौजूद .properties फ़ाइलें पढ़ी जाती हैं. इसका मतलब है कि अपग्रेड करने पर, कॉम्पोनेंट पर सेट की गई कोई भी प्रॉपर्टी बनी रहेगी.

.properties फ़ाइलों की जगह

Edge कॉम्पोनेंट के लिए, .properties फ़ाइलों की तीन टॉप-लेवल डायरेक्ट्री होती हैं: इंस्टॉलेशन, मालिक, और ग्राहक. जगह की डिफ़ॉल्ट जानकारी, इस टेबल में दिखाई गई है:

/opt/apigee/component_name/conf

/opt/apigee/token

/opt/apigee/customer

किसी टोकन की मौजूदा वैल्यू का पता लगाना

कॉम्पोनेंट के लिए .properties फ़ाइल में टोकन सेट करने से पहले, इसकी मौजूदा वैल्यू का पता लगाया जा सकता है. इसके लिए, इस कमांड का इस्तेमाल करें:

/opt/apigee/apigee-service/bin/apigee-service component_name configure -search token

जहां component_name कॉम्पोनेंट का नाम है और token वह टोकन है जिसकी जांच करनी है.

यह कमांड, .properties फ़ाइलों की हैरारकी में खोज करके, टोकन की मौजूदा वैल्यू तय करता है.

उदाहरण के लिए, राऊटर के लिए conf_http_HTTPRequest.line.limit टोकन की मौजूदा वैल्यू देखने के लिए:

/opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

आपको इस फ़ॉर्मैट में आउटपुट दिखेगा:

Found key conf_http_HTTPRequest.line.limit, with value, 4k, in /opt/apigee/edge-router/token/default.properties

.properties फ़ाइलों में टोकन सेट करना

किसी टोकन की वैल्यू बदलने के लिए:

1. टोकन की वैल्यू सेट करने के लिए, कॉम्पोनेंट की .properties फ़ाइल में बदलाव करें. अगर फ़ाइल मौजूद नहीं है, तो उसे बनाएं.
2. कॉम्पोनेंट को रीस्टार्ट करें.
3. टोकन की वैल्यू देखें.

उदाहरण के लिए, Edge Router के लिए अनुरोध की लाइन की सीमा सेट करने के लिए:

1. conf_http_HTTPRequest.line.limit टोकन सेट करने के लिए, /opt/apigee/customer/application/router.properties फ़ाइल में बदलाव करें:

   conf_http_HTTPRequest.line.limit=8k

2. एज राऊटर को रीस्टार्ट करें:

   /opt/apigee/apigee-service/bin/apigee-service edge-router restart

3. टोकन की वैल्यू देखें:

   /opt/apigee/apigee-service/bin/apigee-service edge-router configure -search conf_http_HTTPRequest.line.limit

एक से ज़्यादा वैल्यू वाला टोकन सेट करना

कुछ टोकन में, कॉमा लगाकर अलग की गई वैल्यू की सूची होती है. उदाहरण के लिए, conf_security_rbac.restricted.resources टोकन में ऐसे यूआरआई की सूची होती है जिन पर पाबंदी लगी होती है. इस वजह से, सिर्फ़ सिस्टम एडमिन ही उन्हें कॉल कर सकता है. conf_security_rbac.restricted.resources की वैल्यू देखने के लिए:

cd /opt/apigee/edge-management-server
grep -ri "conf_security_rbac.restricted.resources" *

आउटपुट में ये शामिल हैं:

token/default.properties:conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status

वैल्यू की सूची वाले टोकन को सेट करने के लिए, .properties फ़ाइल में टोकन की मौजूदा वैल्यू में कोई भी नई वैल्यू जोड़ें. इसलिए, यूआरआई /myuri/* को conf_security_rbac.restricted.resources में जोड़ने के लिए, /opt/apigee/customer/application/management-server.properties फ़ाइल में बदलाव करें, जैसा कि यहां दिखाया गया है:

conf_security_rbac.restricted.resources=/environments,/environments/*,/environments/*/virtualhosts,/environments/*/virtualhosts/*,/pods,/environments/*/servers,/rebuildindex,/users/*/status,/myuri/*

किसी टोकन का पता लगाना

ज़्यादातर मामलों में, आपको जो टोकन सेट करने होते हैं उनकी जानकारी इस गाइड में दी गई है. हालांकि, अगर आपको किसी प्रॉपर्टी को बदलने के लिए इस्तेमाल किए गए टोकन का पता लगाना है, तो कॉम्पोनेंट के source फ़ोल्डर में grep करें.

उदाहरण के लिए, अगर आपको पता है कि Edge के पिछले वर्शन में आपने session.maxAge प्रॉपर्टी सेट की थी और आपको उसे सेट करने के लिए इस्तेमाल की गई टोकन वैल्यू जाननी है, तो /opt/apigee/edge-ui/source डायरेक्ट्री में मौजूद प्रॉपर्टी के लिए grep:

grep -ri "session.maxAge" /opt/apigee/edge-ui/source

आपको इस फ़ॉर्मैट में नतीजा दिखेगा:

/opt/apigee/edge-ui/source/conf/application.conf:session.maxAge={T}conf_application_session.maxage{/T}

{T}{/T} टैग के बीच मौजूद स्ट्रिंग, वह टोकन है जिसे आपने .properties फ़ाइल में सेट किया है.

ऐसा टोकन सेट करना जिसे फ़िलहाल टिप्पणी के तौर पर मार्क किया गया है

Edge की कॉन्फ़िगरेशन फ़ाइलों में कुछ टोकन, टिप्पणी के तौर पर मार्क किए गए हैं. अगर आपने कोई ऐसा टोकन सेट करने की कोशिश की है जिसे टिप्पणी के तौर पर मार्क किया गया है, तो सेटिंग को अनदेखा कर दिया जाता है.

टिप्पणी के तौर पर मार्क किए गए टोकन को सेट करने के लिए, आपको एक खास सिंटैक्स का इस्तेमाल करना होगा. इसका फ़ॉर्मैट इस तरह का होता है:

conf/file.extension+propertyName=propertyValue

उदाहरण के लिए, आपको मैसेज प्रोसेसर पर HTTPClient.proxy.host नाम की प्रॉपर्टी सेट करनी है. इसके बाद, प्रॉपर्टी के लिए grep करें, ताकि उसके टोकन का पता लगाया जा सके:

cd /opt/apigee/edge-message-processor
grep -ri "HTTPClient.proxy.host" *

grep कमांड, टोकन वैल्यू वाले फ़ॉर्म में नतीजे दिखाता है. ध्यान दें कि प्रॉपर्टी के नाम को टिप्पणी के तौर पर कैसे मार्क किया गया है. इसके लिए, प्रॉपर्टी के नाम के आगे # प्रीफ़िक्स लगाया गया है:

source/conf/http.properties:#HTTPClient.proxy.host={T}conf_http_HTTPClient.proxy.host{/T}
token/default.properties:conf_http_HTTPClient.proxy.host=
conf/http.properties:#HTTPClient.proxy.host=

प्रॉपर्टी सेट करने के लिए, /opt/apigee/customer/application/message-processor.properties में बदलाव करें, ताकि प्रॉपर्टी को इस तरह सेट किया जा सके:

conf/http.properties+HTTPClient.proxy.host=myhost.name.com

ध्यान दें कि प्रॉपर्टी के नाम से पहले conf/http.properties+ कैसे लगाया जाता है. यह प्रॉपर्टी वाली कॉन्फ़िगरेशन फ़ाइल की जगह और नाम के बाद "+" लगाकर किया जाता है.

मैसेज प्रोसेसर को रीस्टार्ट करने के बाद, /opt/apigee/edge-message-processor/conf/http.properties फ़ाइल की जांच करें:

cat /opt/apigee/edge-message-processor/conf/http.properties

फ़ाइल के आखिर में, आपको प्रॉपर्टी सेट इस फ़ॉर्म में दिखेगा:

conf/http.properties:HTTPClient.proxy.host=myhost.name.com