התקנת פורטלים לשירותים למפתחים

Edge for Private Cloud גרסה 4.17.05

לפני ההתקנה, חשוב לוודא את הפרטים הבאים:

• מתקינים את Postgres לפני שמתקינים את הפורטל. אפשר להתקין את Postgres כחלק מהתקנת Edge, או להתקין את Postgres בנפרד לשימוש הפורטל.
  • אם מתקינים את Postgres באופן עצמאי, הוא יכול להיות באותו צומת שבו נמצא הפורטל.
  • אם מתחברים ל-Postgres שמותקנת כחלק מ-Edge, ו-Postgres מוגדר במצב ראשי/המתנה, יש לציין את כתובת ה-IP של שרת Postgres הראשי.
• ההתקנה מתבצעת בגרסת 64 ביט של גרסה נתמכת של Red Hat Enterprise Linux, CentOS או Oracle. אפשר לעיין ברשימת הגרסאות הנתמכות במאמר תוכנות נתמכות וגרסאות נתמכות.
• Yum הותקנה.

סקירה כללית של ההתקנה

אחרי שמתקינים את כלי השירות 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.

יצירת קובץ תצורה

למטה מוצג קובץ תצורה שקט לדוגמה להתקנת פורטל. עורכים את הקובץ הזה לפי הצורך בהגדרות האישיות שלכם. יש להשתמש באפשרות -f כדי setup.sh כדי לכלול את הקובץ הזה.

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

בודקים את החיבור לשרת הניהול של Edge על ידי הרצת פקודת ה-cURL הבאה משורת הפקודה בשרת הפורטל:

> 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. אם מתחברים לארגון בענן, כתובת ה-URL של הבקשה היא: 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. אפשר להתקין את Postgres כחלק מהתקנת Edge, או להתקין את Postgres בנפרד לשימוש הפורטל.

• אם אתם מתחברים ל-Postgres שמותקנת כחלק מ-Edge, ו-Postgres מוגדר במצב ראשי/המתנה, יש לציין את כתובת ה-IP של שרת Postgres הראשי.
• אם מתקינים את Postgres באופן עצמאי, הוא יכול להיות באותו צומת שבו נמצא הפורטל.

למידע על התקנת Postgres כחלק מהתקנת Edge, אפשר לעיין בהתקנת רכיבי Edge בצומת.

כדי להתקין את Postgres באופן עצמאי:

1. מתקינים את הכלי apigee-setup בצומת באמצעות הליך אינטרנט או ללא חיבור לאינטרנט. למידע נוסף, אפשר לקרוא את המאמר התקנת כלי ההגדרה של Edge apigee-setup.
2. יוצרים קובץ תצורה עבור Postgres, כפי שמוצג בהמשך:
   
   # חייב להיות זהה לכתובת IP או לשם ה-DNS של המארח – לא ל-127.0.0.1 או ל-localhost.
   HOSTIP=$(hostname -i)
   
   # ה-pod והאזור של 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. מתקינים את הכלי apigee-setup של Edge בצומת באמצעות הליך אינטרנט או ללא חיבור לאינטרנט. למידע נוסף, אפשר לקרוא את המאמר התקנת כלי ההגדרה של Edge apigee-setup.
2. צריך לוודא שהתקנת את Postgres, בנפרד או כחלק מהתקנת Edge.
3. בשורת הפקודה, מריצים את סקריפט ההגדרה:
   > /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile
   
   האפשרות ' -p dp' מציינת אם להתקין את הפורטל.
   
   קובץ התצורה חייב להיות נגיש או קריא למשתמש "apigee".
4. עוברים אל דף הבית של הפורטל בכתובת http://localhost:8079 או אל שם ה-DNS של הפורטל.
5. מתחברים לפורטל באמצעות פרטי הכניסה של האדמין שהגדרתם בקובץ התצורה.

5. ודאו שהמודול של מנהל העדכונים מופעל

כדי לקבל התראות על עדכונים של Drupal, צריך לוודא שמודול הניהול של Drupal Update מופעל. בתפריט Drupal, בוחרים באפשרות Modules וגוללים למטה אל המודול Update manager. אם היא לא מופעלת, מפעילים אותה.

לאחר ההפעלה, אפשר לראות את העדכונים הזמינים דרך פריט התפריט דוחות > עדכונים זמינים. אפשר גם להשתמש בפקודה הבאה של Drush:

> drush pm-info update

צריך להריץ את הפקודה הזו מספריית השורש של האתר. כברירת מחדל, הפורטל למפתחים מותקן בכתובת /opt/apigee/apigee-drupal/wwwroot. לכן צריך לשנות את הספרייה ל-/opt/apigee/apigee-drupal/wwwroot לפני הרצת הפקודה. אם לא התקנתם את הפורטל בספריית ברירת המחדל, שנו את ספריית ההתקנה שלכם.

בתפריט דוחות > עדכונים זמינים > הגדרות, אפשר להגדיר שהמודול ישלח לך אימייל כשיהיו עדכונים זמינים, וכדי להגדיר את התדירות לבדיקת עדכונים.

6. הגדרת מנוע החיפוש Apache Solr (אופציונלי)

כברירת מחדל, המודולים של Drupal שמתחברים למנוע החיפוש Apache Solr מושבתים כשמתקינים את הפורטל. ברוב הפורטלים נעשה שימוש במנוע החיפוש הפנימי של Drupal, ולכן לא נדרשים המודולים של Drupal Solr.

אם מחליטים להשתמש ב-Solr כמנוע החיפוש, צריך להתקין את ה-Solr באופן מקומי בשרת, ואז להפעיל ולהגדיר את המודולים של Drupal Solr בפורטל.

כדי להפעיל את המודולים של Drupal Solr:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בוחרים באפשרות מודולים בתפריט Drupal.
3. מפעילים את המודול Apache Solr Framework ואת המודול Apache Solr Search.
4. שומרים את השינויים.
5. מגדירים את ה-Solr כפי שמתואר בכתובת https://drupal.org/node/1999280.

7. התקנת SmartDocs (אופציונלי)

בעזרת SmartDocs, ניתן לתעד את ממשקי ה-API בפורטל השירותים למפתחים באופן שהופך את מסמכי ה-API לאינטראקטיביים לחלוטין. עם זאת, כדי להשתמש ב-SmartDocs באמצעות הפורטל, קודם צריך להתקין את SmartDocs ב-Edge.

• אם אתם מחברים את הפורטל להתקנת Edge Cloud, סימן ש-SmartDocs כבר מותקן ואין צורך בהגדרה נוספת.
• אם מחברים את הפורטל ל-Edge לצורך התקנת ענן פרטי, צריך לוודא ש-SmartDocs מותקן ב-Edge. למידע נוסף על התקנת Edge ו-SmartDocs, אפשר לעיין במאמר התקנת SmartDocs.

צריך גם להפעיל את SmartDocs בפורטל. מידע נוסף על SmartDocs זמין במאמר שימוש ב-SmartDocs לתיעוד ממשקי API.

8. הגדרת המודול של Jquery Update להתקנות שלא באינטרנט (אופציונלי)

אם מתקינים את המודול JQuery Update ומשתמשים בו בהתקנה שלא מחוברת לאינטרנט, צריך להגדיר את המודול כך שישתמש בגרסה המקומית של JQuery. אם תגדיר את המודול לשימוש ב-CDN עבור התקנה שלא מחוברת לאינטרנט, הוא ינסה לגשת ל-CDN ויגרום לעיכובים בטעינת הדף. מידע נוסף על המודול Jquery Update זמין בכתובת https://www.drupal.org/project/jquery_update.

כדי להגדיר את המודול JQuery Update כך שישתמש בגרסה המקומית של JQuery:

1. אתם יכולים להתחבר לפורטל שלכם כמשתמשים עם הרשאות אדמין או יצירת תוכן.
2. בתפריט Drupal, בוחרים באפשרות Configuration > Development > JQuery Update.
3. בתפריט הניווט הימני לוחצים על ביצועים.
4. בתפריט הנפתח JQuery ו-JQuery UI CDN, בוחרים באפשרות ללא.
5. לוחצים על Save configuration (שמירת ההגדרות האישיות).

9. מה השלבים הבאים?

אחרי שמתקינים את פורטל השירותים למפתחים, צריך להגדיר אותו ולהתאים אותו לדרישות הספציפיות שלך. התיעוד באתר Apigee מכיל את כל המידע על הגדרה, עיצוב וניהול פורטל. ניתן לגשת למסמכים בכתובת http://apigee.com/docs/developer-services/content/what-developer-portal.

בטבלה הבאה מפורטות חלק מהמשימות הנפוצות ביותר שאפשר לבצע לאחר ההתקנה, וכוללת קישורים למסמכי התיעוד של Apigee שבהם תוכלו למצוא מידע נוסף:

משימה	תיאור
התאמה אישית של העיצוב	העיצוב מגדיר את מראה הפורטל, כולל הצבעים, העיצוב והיבטים ויזואליים אחרים.
התאמה אישית של המראה	דף הבית כולל את התפריט הראשי, הודעת הפתיחה, כותרת עליונה, כותרת תחתונה וכותרת.
הוספה וניהול של חשבונות משתמשים	תהליך ההרשמה קובע איך מפתחים חדשים רושמים חשבון בפורטל. לדוגמה: האם מפתחים חדשים מקבלים גישה מיידית לפורטל או שאדמין צריך לאמת אותם. התהליך הזה גם קובע איך האדמין של הפורטל מקבל התראה כשיוצרים חשבון חדש.
הגדרת האימייל	הפורטל שולח הודעות אימייל בתגובה לאירועים מסוימים. לדוגמה, כשמפתח חדש נרשם לפורטל או כשמפתח מאבד את הסיסמה שלו.
הוספה וניהול של חשבונות משתמשים	יש להוסיף דף תנאים והגבלות שהמפתחים חייבים לאשר כדי לקבל גישה לפורטל.
הוספה וניהול של חשבונות משתמשים	בפורטל מוטמע מודל הרשאה מבוסס תפקיד. לפני שמאפשרים למפתחים להירשם, צריך להגדיר את ההרשאות והתפקידים שמשמשים את הפורטל.
הוספת פוסטים בבלוגים ובפורומים	בפורטל יש תמיכה מובנית בבלוגים ובפורומים עם שרשורים. הגדר את ההרשאות הנדרשות כדי להציג, להוסיף, לערוך ולמחוק פוסטים בבלוגים ובפורומים.
לוודא שמתבצע גיבויים של מסדי נתונים	מוודאים שמסד הנתונים של Drupal מגובה. הערה: מאחר שכל התקנה היא שונה, אתה מחליט מהי הדרך הטובה ביותר לגבות את מסד הנתונים. הערה: המודול Backup and Migrate לא תואם למסדי נתונים של Postgres. למידע נוסף, ראו איך לבצע גיבוי.
הגדרה של שם מארח	אם לא מגדירים שם מארח בשרת ה-DNS, תמיד אפשר לגשת לאתר דרך כתובת ה-IP של השרת. אם רוצים להשתמש בשם מארח, אפשר להגדיר את ה-DNS של השרת, שאמור לפעול כמו שצריך ללא הגדרות אחרות בהגדרה בסיסית. אם מגדירים מאזן עומסים או מקבלים כתובות URL שגויות באתר מסיבה אחרת, אפשר להגדיר את $base_url בקובץ settings.php של Dev Portal. הקובץ נמצא כברירת מחדל בספרייה /opt/apigee/apigee-drupal/wwwroot/sites/default.
פיתוח מותאם אישית	מומלץ גם להרחיב את יכולות הפורטל באמצעות קוד מותאם אישית מחוץ לעיצוב. לשם כך, צריך ליצור מודול Drupal משלך, כפי שמתואר בנושאים שקשורים לפיתוח מודולים ב-Drupal, ולהציב את המודול בספרייה /sites/all/modules.