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

Edge for Private Cloud v. 4.17.01

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

  • पोर्टल इंस्टॉल करने से पहले, 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 पर इंस्टॉल करने के लिए, खास होस्टनेम और पोर्ट नंबर की जानकारी ज़रूर दें. पोर्ट 8080, Edge का डिफ़ॉल्ट पोर्ट है. अगर आपको क्लाउड में किसी संगठन से कनेक्ट करना है, तो अनुरोध का यूआरएल यह होगा: 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

CentOS और RedHat Enterprise Linux (RHEL) के लिए, PHP पैकेज हटाने के लिए, नीचे दिए गए कमांड का इस्तेमाल करें:

yum remove <package-name>

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

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

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

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

Postgres स्टैंडअलोन इंस्टॉल करने के लिए:

  1. इंटरनेट या बिना इंटरनेट वाले तरीके का इस्तेमाल करके, नोड पर Edge apigee-setup यूटिलिटी इंस्टॉल करें. ज़्यादा जानकारी के लिए, Edge apigee-setup सुविधा को इंस्टॉल करना देखें.
  2. Postgres के लिए कॉन्फ़िगरेशन फ़ाइल बनाएं, जैसा कि यहां दिखाया गया है:

    # 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” विकल्प से Postgres इंस्टॉल करने की जानकारी मिलती है.

    कॉन्फ़िगरेशन फ़ाइल ऐसी होनी चाहिए जिसे "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 अपडेट मैनेजर मॉड्यूल चालू हो. Drupal मेन्यू में, मॉड्यूल चुनें और नीचे की ओर स्क्रोल करके, अपडेट मैनेजर मॉड्यूल पर जाएं. अगर यह सुविधा चालू नहीं है, तो इसे चालू करें.

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

> drush pm-info update

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

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

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

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

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

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

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

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

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

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

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

8. आगे क्या?

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

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

टास्क

जानकारी

थीम को पसंद के मुताबिक बनाना

थीम से पोर्टल के दिखने का तरीका तय होता है. इसमें रंग, स्टाइल, और विज़ुअल के अन्य पहलू शामिल होते हैं.

दिखने का तरीका अपनी पसंद के मुताबिक बनाना

होम पेज पर मुख्य मेन्यू, वेलकम मैसेज, हेडर, फ़ुटर, और टाइटल शामिल होते हैं.

उपयोगकर्ता खाते जोड़ना और उन्हें मैनेज करना

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

ईमेल को कॉन्फ़िगर करना

पोर्टल, कुछ खास इवेंट के जवाब में ईमेल भेजता है. उदाहरण के लिए, जब कोई नया डेवलपर पोर्टल पर रजिस्टर करता है और जब किसी डेवलपर को अपना पासवर्ड याद नहीं रहता.

उपयोगकर्ता खाते जोड़ना और उन्हें मैनेज करना

नियमों और शर्तों वाला वह पेज जोड़ें जिसे पोर्टल को ऐक्सेस करने की अनुमति देने से पहले, डेवलपर को स्वीकार करना होगा.

उपयोगकर्ता खाते जोड़ना और उन्हें मैनेज करना

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

ब्लॉग और फ़ोरम पोस्ट जोड़ना

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

पक्का करें कि आपने डेटाबेस का बैक अप लिया हो

पक्का करें कि आपने Drupal डेटाबेस का बैक अप लिया हो. ध्यान दें कि हर इंस्टॉलेशन अलग होता है. इसलिए, यह आपको तय करना होता है कि डेटाबेस का बैक अप कैसे लिया जाए.

ध्यान दें: बैकअप और माइग्रेट मॉड्यूल, Postgres डाटाबेस के साथ काम नहीं करता.

बैकअप लेने का तरीका भी देखें.

होस्टनेम सेट अप करना

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

अगर आपने लोड बैलेंसर सेट अप किया है या किसी और वजह से आपकी साइट पर गलत यूआरएल दिख रहे हैं, तो डेवलपर पोर्टल की settings.php फ़ाइल में $base_url सेट किया जा सकता है. यह फ़ाइल डिफ़ॉल्ट रूप से, /opt/apigee/apigee-drupal/sites/default डायरेक्ट्री में मौजूद होती है.

कस्टम डेवलपमेंट अपनी थीम के अलावा, कस्टम कोड का इस्तेमाल करके भी पोर्टल की सुविधाओं को बेहतर बनाया जा सकता है. ऐसा करने के लिए, Drupal के मॉड्यूल के डेवलपमेंट से जुड़े विषयों में बताए गए तरीके से अपना Drupal मॉड्यूल बनाएं. इसके बाद, मॉड्यूल को /sites/all/modules डायरेक्ट्री में डालें.