डेवलपर सेवाओं के लिए पोर्टल इंस्टॉल करना

Edge for Private Cloud v. 4.17.05

इंस्टॉल करने से पहले, पक्का करें कि:

• पोर्टल इंस्टॉल करने से पहले, Postgres इंस्टॉल करें. Edge इंस्टॉल करते समय, Postgres को इंस्टॉल किया जा सकता है. इसके अलावा, पोर्टल के इस्तेमाल के लिए Postgres को अलग से इंस्टॉल किया जा सकता है.
  • अगर Postgres को स्टैंडअलोन के तौर पर इंस्टॉल किया जाता है, तो यह पोर्टल वाले नोड पर ही हो सकता है.
  • अगर Edge के हिस्से के तौर पर इंस्टॉल किए गए Postgres से कनेक्ट किया जा रहा है और Postgres को मास्टर/स्टैंडबाय मोड में कॉन्फ़िगर किया गया है, तो मास्टर Postgres सर्वर का आईपी पता डालें.
• Red Hat Enterprise Linux, CentOS या Oracle के 64-बिट वर्शन पर इंस्टॉल किया जा रहा हो. इस्तेमाल किए जा सकने वाले सॉफ़्टवेयर और उनके वर्शन पर जाकर, इस्तेमाल किए जा सकने वाले वर्शन की सूची देखें.
• Yum इंस्टॉल हो.

इंस्टॉल करने के बारे में खास जानकारी

किसी नोड पर Edge apigee-setup यूटिलिटी इंस्टॉल करने के बाद, उस यूटिलिटी का इस्तेमाल करके नोड पर पोर्टल इंस्टॉल करें. apigee-setup यूटिलिटी का फ़ॉर्मैट इस तरह का होता है:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

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

इसके लिए, सिर्फ़ यह ज़रूरी है कि कॉन्फ़िगरेशन फ़ाइल को "apigee" उपयोगकर्ता ऐक्सेस कर सके या पढ़ सके.

उदाहरण के लिए, पोर्टल इंस्टॉल करने के लिए इस कमांड का इस्तेमाल करें:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

ज़्यादा जानकारी के लिए, Edge apigee-setup यूटिलिटी इंस्टॉल करना लेख पढ़ें.

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

पोर्टल इंस्टॉल करने के लिए, साइलेंट कॉन्फ़िगरेशन फ़ाइल का एक उदाहरण यहां दिया गया है. अपने कॉन्फ़िगरेशन के हिसाब से, इस फ़ाइल में बदलाव करें. इस फ़ाइल को शामिल करने के लिए, setup.sh में -f विकल्प का इस्तेमाल करें.

IP1=IPorDNSnameOfNode

# Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost.
HOSTIP=$(hostname -i)

# Specify the name of the portal database in Postgres. 
PG_NAME=devportal 

# Specify the Postgres admin credentials. 
# The portal connects to Postgres by using the 'apigee' user. 
# If you changed the Postgres password from the default of 'postgres' 
# then set PG_PWD accordingly. 
# If connecting to a Postgres node installed with Edge, 
# contact the Edge sys admin to get these credentials. 
PG_USER=apigee 
PG_PWD=postgres 

# The IP address of the Postgres server. 
# If it is installed on the same node as the portal, specify that IP. 
# If connecting to a remote Postgres server,specify its IP address. 
PG_HOST=$IP1 

# The Postgres user credentials used by the portal 
# to access the Postgres database, 
# This account is created if it does not already exist. 
DRUPAL_PG_USER=drupaladmin 
DRUPAL_PG_PASS=portalSecret 

# Specify 'postgres' as the database. 
DEFAULT_DB=postgres 

# Specify the Drupal admin account details. 
# DO NOT set DEVPORTAL_ADMIN_USERNAME=admin. 
# The installer creates this user on the portal. 
DEVPORTAL_ADMIN_FIRSTNAME=firstName 
DEVPORTAL_ADMIN_LASTNAME=lastName 
DEVPORTAL_ADMIN_USERNAME=userName 
DEVPORTAL_ADMIN_PWD=pWord 
DEVPORTAL_ADMIN_EMAIL=foo@bar.com 

# Edge connection details. 
# If omitted, you can set them in the portal UI. 
# Specify the Edge organization associated with the portal. 
EDGE_ORG=edgeOrgName 

# Specify the URL of the Edge management API. 
# For a Cloud based installation of Edge, the URL is: 
# https://api.enterprise.apigee.com/v1 
# For a Private Cloud installation, it is in the form: 
# http://<ms_ip_or_DNS>:8080/v1 or 
# https://<ms_ip_or_DNS>:TLSport/v1 
MGMT_URL=https://api.enterprise.apigee.com/v1 

# The org admin credentials for the Edge organization in the form
# of Edge emailAddress:pword. 
# The portal uses this information to connect to Edge. 
DEVADMIN_USER=orgAdmin@myCorp.com 
DEVADMIN_PWD=pWord 

# The PHP port. 
# If omitted, it defaults to 8888. 
PHP_FPM_PORT=8888 

# You must configure the SMTP server used by the portal. 
# The properties SMTPHOST and SMTPPORT are required. 
# The others are optional with a default value as notated below. 
# SMTP hostname. For example, for the Gmail server, use smtp.gmail.com. 
SMTPHOST=smtp.gmail.com 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

# SMTP port (usually 25). 
# The value can be different based on the selected encryption protocol. 
# For example, for Gmail, the port is 465 when using SSL and 587 for TLS. 
SMTPPORT=25 

# Username used for SMTP authentication, defaults is blank. 
SMTPUSER=your@email.com 

# Password used for SMTP authentication, default is blank. 
SMTPPASSWORD=yourEmailPassword

1. Apigee Edge से अपने कनेक्शन की जांच करना

पोर्टल सर्वर पर कमांड प्रॉम्प्ट से यह cURL कमांड चलाकर, Edge मैनेजमेंट सर्वर से अपने कनेक्शन की जांच करें:

> curl -u {EMAIL}:{PASSWORD} http://<ms_ip_or_DNS>:8080/v1/organizations/{ORGNAME}

या:

> curl -u {EMAIL}:{PASSWORD} https://<ms_ip_or_DNS>:TLSPort/v1/organizations/{ORGNAME}

जहां EMAIL और PASSWORD, ORGNAME के एडमिन का ईमेल पता और पासवर्ड है.

पक्का करें कि आपने Edge के अपने इंस्टॉलेशन के लिए, होस्टनेम और पोर्ट नंबर डाला हो. Edge, डिफ़ॉल्ट रूप से पोर्ट 8080 का इस्तेमाल करता है. अगर आपको क्लाउड में किसी संगठन से कनेक्ट करना है, तो अनुरोध का यूआरएल यह होगा: https://api.enterprise.apigee.com/v1/organizations/{ORGNAME}.

अगर यह कमांड सही से काम करता है, तो आपको इस तरह का जवाब मिलेगा:

{
  "createdAt" : 1348689232699,
  "createdBy" : "USERNAME",
  "displayName" : "cg",
  "environments" : [ "test", "prod" ],
  "lastModifiedAt" : 1348689232699,
  "lastModifiedBy" : "foo@bar.com",
  "name" : "cg",
  "properties" : {
    "property" : [ ]
  },
  "type" : "trial"
}

2. PHP के 7.0 से पहले के वर्शन हटाना

इंस्टॉल करने की स्क्रिप्ट, सिस्टम पर PHP के 7.0 से पहले के वर्शन की जांच करती है. इसके बाद, इंस्टॉल करने की प्रोसेस शुरू होती है. अगर PHP के 7.0 से पहले के वर्शन मौजूद हैं, तो चेतावनी देने वाला यह मैसेज दिखता है:

The following packages present on your system conflict with software we are
about to install. You will need to manually remove each one, then re-run this install script.

php
php-cli
php-common
php-gd
php-mbstring
php-mysql
php-pdo
php-pear
php-pecl-apc
php-process
php-xml

इस कमांड का इस्तेमाल करके, PHP पैकेज हटाएं:

yum remove <package-name>

3. Postgres इंस्टॉल करना

पोर्टल इंस्टॉल करने से पहले, Postgres इंस्टॉल करना ज़रूरी है. Edge इंस्टॉल करते समय Postgres को इंस्टॉल किया जा सकता है. इसके अलावा, पोर्टल के इस्तेमाल के लिए Postgres को अलग से इंस्टॉल किया जा सकता है.

• अगर Edge के हिस्से के तौर पर इंस्टॉल किए गए Postgres से कनेक्ट किया जा रहा है और Postgres को मास्टर/स्टैंडबाय मोड में कॉन्फ़िगर किया गया है, तो मास्टर Postgres सर्वर का आईपी पता डालें.
• अगर Postgres को स्टैंडअलोन के तौर पर इंस्टॉल किया जाता है, तो यह पोर्टल वाले नोड पर ही हो सकता है.

Edge इंस्टॉल करने के दौरान Postgres इंस्टॉल करने के बारे में जानकारी पाने के लिए, नोड पर Edge कॉम्पोनेंट इंस्टॉल करना लेख पढ़ें.

Postgres standalone इंस्टॉल करने के लिए:

1. इंटरनेट या बिना इंटरनेट वाली प्रोसेस का इस्तेमाल करके, नोड पर Edge apigee-setup यूटिलिटी इंस्टॉल करें. ज़्यादा जानकारी के लिए, Edge apigee-setup यूटिलिटी इंस्टॉल करना लेख पढ़ें.
2. Postgres के लिए एक कॉन्फ़िगरेशन फ़ाइल बनाएं, जैसा कि यहां दिखाया गया है:
   
   # इसे होस्ट के आईपी पते या डीएनएस नाम पर रिज़ॉल्व होना चाहिए - 127.0.0.1 या लोकल होस्ट पर नहीं.
   HOSTIP=$(hostname -i)
   
   # Postgres का पॉड और क्षेत्र. नीचे दी गई डिफ़ॉल्ट वैल्यू का इस्तेमाल करें.
   MP_POD=gateway
   REGION=dc-1
   
   # Postgres पासवर्ड सेट करें. डिफ़ॉल्ट वैल्यू 'postgres' होती है.
   PG_PWD=postgres
3. कमांड प्रॉम्प्ट पर, Postgres को इंस्टॉल करने के लिए सेटअप स्क्रिप्ट चलाएं:
   > /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile
   
   “-p pdb” विकल्प, Postgre को इंस्टॉल करने के लिए है.
   
   कॉन्फ़िगरेशन फ़ाइल को "apigee" उपयोगकर्ता ऐक्सेस कर सकता हो या पढ़ सकता हो.

4. पोर्टल इंस्टॉल करना

पोर्टल इंस्टॉल करने के लिए:

1. इंटरनेट या बिना इंटरनेट वाली प्रोसेस का इस्तेमाल करके, नोड पर Edge apigee-setup यूटिलिटी इंस्टॉल करें. ज़्यादा जानकारी के लिए, Edge apigee-setup यूटिलिटी इंस्टॉल करना लेख पढ़ें.
2. पक्का करें कि आपने Postgres इंस्टॉल किया हो. इसके लिए, Postgres को अलग से इंस्टॉल किया जा सकता है या Edge इंस्टॉल करते समय इसे इंस्टॉल किया जा सकता है.
3. कमांड प्रॉम्प्ट पर, सेटअप स्क्रिप्ट चलाएं:
   > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
   
   “-p dp” विकल्प से, पोर्टल को इंस्टॉल करने के बारे में पता चलता है.
   
   कॉन्फ़िगरेशन फ़ाइल को "apigee" उपयोगकर्ता ऐक्सेस कर सकता हो या पढ़ सकता हो.
4. पोर्टल के होम पेज http://localhost:8079 या अपने पोर्टल के डीएनएस नाम पर जाएं.
5. कॉन्फ़िगरेशन फ़ाइल में सेट किए गए एडमिन क्रेडेंशियल का इस्तेमाल करके, पोर्टल में लॉग इन करें.

5. पक्का करें कि अपडेट मैनेजर मॉड्यूल चालू हो

Drupal के अपडेट की सूचनाएं पाने के लिए, पक्का करें कि Drupal Update manager मॉड्यूल चालू हो. Drupal मेन्यू में जाकर, Modules चुनें और नीचे की ओर स्क्रोल करके, Update manager मॉड्यूल पर जाएं. अगर यह चालू नहीं है, तो इसे चालू करें.

इस सुविधा के चालू होने के बाद, उपलब्ध अपडेट देखे जा सकते हैं. इसके लिए, रिपोर्ट > उपलब्ध अपडेट मेन्यू आइटम का इस्तेमाल करें. इस Drush कमांड का भी इस्तेमाल किया जा सकता है:

> drush pm-info update

आपको यह कमांड, साइट की रूट डायरेक्ट्री से चलाना होगा. डिफ़ॉल्ट रूप से, डेवलपर पोर्टल /opt/apigee/apigee-drupal/wwwroot पर इंस्टॉल होता है. इसलिए, कमांड चलाने से पहले आपको डायरेक्ट्री को /opt/apigee/apigee-drupal/wwwroot में बदलना होगा. अगर आपने पोर्टल को डिफ़ॉल्ट डायरेक्ट्री में इंस्टॉल नहीं किया है, तो अपनी इंस्टॉलेशन डायरेक्ट्री में जाएं.

रिपोर्ट > उपलब्ध अपडेट > सेटिंग मेन्यू आइटम का इस्तेमाल करके, मॉड्यूल को कॉन्फ़िगर करें. इससे अपडेट उपलब्ध होने पर आपको ईमेल मिलेगा. साथ ही, अपडेट की जांच करने की फ़्रीक्वेंसी सेट की जा सकेगी.

6. Apache Solr सर्च इंजन को कॉन्फ़िगर करना (ज़रूरी नहीं)

पोर्टल इंस्टॉल करने पर, Apache Solr सर्च इंजन से कनेक्ट होने वाले Drupal मॉड्यूल डिफ़ॉल्ट रूप से बंद रहते हैं. ज़्यादातर पोर्टल, Drupal के इंटरनल सर्च इंजन का इस्तेमाल करते हैं. इसलिए, उन्हें Drupal Solr मॉड्यूल की ज़रूरत नहीं होती.

अगर आपको Solr को अपने सर्च इंजन के तौर पर इस्तेमाल करना है, तो आपको अपने सर्वर पर Solr को स्थानीय तौर पर इंस्टॉल करना होगा. इसके बाद, पोर्टल पर Drupal Solr मॉड्यूल को चालू और कॉन्फ़िगर करना होगा.

Drupal Solr मॉड्यूल चालू करने के लिए:

1. अपने पोर्टल में ऐसे उपयोगकर्ता के तौर पर लॉग इन करें जिसके पास एडमिन या कॉन्टेंट बनाने के अधिकार हों.
2. Drupal मेन्यू में जाकर, Modules को चुनें.
3. Apache Solr Framework मॉड्यूल और Apache Solr Search मॉड्यूल को चालू करें.
4. बदलावों को सेव करें.
5. https://drupal.org/node/1999280 पर बताए गए तरीके से Solr को कॉन्फ़िगर करें.

7. SmartDocs इंस्टॉल करना (ज़रूरी नहीं)

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

• अगर पोर्टल को Edge Cloud इंस्टॉलेशन से कनेक्ट किया जा रहा है, तो SmartDocs पहले से इंस्टॉल होता है. इसके लिए, किसी और कॉन्फ़िगरेशन की ज़रूरत नहीं होती.
• अगर पोर्टल को Edge for Private Cloud इंस्टॉलेशन से कनेक्ट किया जा रहा है, तो आपको यह पक्का करना होगा कि Edge पर SmartDocs इंस्टॉल हो. Edge और SmartDocs को इंस्टॉल करने के बारे में ज़्यादा जानने के लिए, SmartDocs इंस्टॉल करना लेख पढ़ें.

आपको पोर्टल पर SmartDocs को भी चालू करना होगा. SmartDocs के बारे में ज़्यादा जानने के लिए, एपीआई का दस्तावेज़ बनाने के लिए SmartDocs का इस्तेमाल करना लेख पढ़ें.

8. इंटरनेट के बिना इंस्टॉल करने के लिए, JQuery Update मॉड्यूल को कॉन्फ़िगर करना (ज़रूरी नहीं)

अगर आपने JQuery Update मॉड्यूल को बिना इंटरनेट के इंस्टॉल और इस्तेमाल किया है, तो आपको मॉड्यूल को JQuery के लोकल वर्शन का इस्तेमाल करने के लिए कॉन्फ़िगर करना होगा. अगर आपने बिना इंटरनेट वाले इंस्टॉलेशन के लिए, सीडीएन का इस्तेमाल करने के लिए मॉड्यूल को कॉन्फ़िगर किया है, तो यह सीडीएन को ऐक्सेस करने की कोशिश करेगा. इससे पेज लोड होने में देरी होगी. JQuery Update मॉड्यूल के बारे में ज़्यादा जानने के लिए, https://www.drupal.org/project/jquery_update पर जाएं.

JQuery के लोकल वर्शन का इस्तेमाल करने के लिए, JQuery Update मॉड्यूल को कॉन्फ़िगर करने का तरीका:

1. अपने पोर्टल में ऐसे उपयोगकर्ता के तौर पर लॉग इन करें जिसके पास एडमिन या कॉन्टेंट बनाने के अधिकार हों.
2. Drupal मेन्यू में, Configuration > Development > JQuery Update को चुनें.
3. बाईं ओर मौजूद नेविगेशन मेन्यू में, परफ़ॉर्मेंस पर क्लिक करें.
4. JQuery और JQuery यूज़र इंटरफ़ेस सीडीएन ड्रॉप-डाउन में, कोई नहीं चुनें.
5. कॉन्फ़िगरेशन सेव करें पर क्लिक करें.

9. आगे क्या करना है?

डेवलपर सेवाओं के पोर्टल को इंस्टॉल करने के बाद, आपको अपनी खास ज़रूरतों के हिसाब से इसे कॉन्फ़िगर और पसंद के मुताबिक बनाना होगा. Apigee की वेबसाइट पर मौजूद दस्तावेज़ में, पोर्टल को कॉन्फ़िगर करने, स्टाइल करने, और मैनेज करने के बारे में पूरी जानकारी दी गई है. http://apigee.com/docs/developer-services/content/what-developer-portal पर जाकर दस्तावेज़ ऐक्सेस करें.

नीचे दी गई टेबल में, इंस्टॉल करने के बाद किए जाने वाले कुछ सबसे सामान्य टास्क की सूची दी गई है. साथ ही, Apigee के दस्तावेज़ों के लिंक भी दिए गए हैं. इन लिंक पर जाकर, आपको ज़्यादा जानकारी मिल सकती है: