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

Developer Services Portal v. 4.16.05

כדי להתקין את פורטל Developer Channel Services, פועלים לפי השלבים הבאים.

לפני שמתחילים בהתקנה, צריך לגבות את כל תיקיית השורש של Drupal. מיקום ההתקנה שמוגדר כברירת מחדל הוא /var/www/html, אבל יכול להיות ששיניתם אותו בזמן ההתקנה. אחרי שתבצעו את שלבי ההתקנה שמתוארים בהמשך, תוכלו לשחזר את ההתאמות האישיות מהגיבוי.

1. איך מקבלים את חבילת השירותים לערוצי מפתחים

נכנסים לכתובת http://community.apigee.com/content/apigee-customer-support ובוחרים באפשרות Login to your Support Portal כדי לבקש את קובץ ה-‎ .tar של Developer Channel Services באחת משתי דרכים:

• מבקשים גישה לספריית ההורדות של Edge for Private Cloud.
• מבקשים כתובת URL לקובץ ‎ .tar של Developer Channel Services.

2. מוודאים שהמערכת עומדת בדרישות המערכת

לפני שמתקינים את הפורטל, השרת צריך לעמוד בדרישות הבאות:

1. חשוב לוודא שאתם מתקינים את גרסת 64 ביט של גרסה נתמכת של Red Hat Enterprise Linux,‏ CentOS או Oracle. כאן אפשר לראות את רשימת הגרסאות הנתמכות.
2. מוודאים ש-Yum מותקן.
3. (להתקנה בשרת ללא חיבור לאינטרנט) קודם צריך להוריד את כל הקבצים הדרושים לשרת עם חיבור לאינטרנט כקובץ ‎.tar.gz יחיד. לאחר מכן, מעתיקים את קובץ ה-‎ .tar.gz לשרת ללא חיבור לאינטרנט כדי לבצע את ההתקנה.
   1. מתחברים לשרת עם חיבור לאינטרנט בתור משתמש root או משתמש-על.
   2. יוצרים ספרייה לקובצי ההתקנה, למשל portal_tar.
   3. עוברים לספרייה החדשה ומורידים את הקובץ DeveloperServices_x.y.z.tar של שירותי Developer Channel, כאשר x.y.z תואם למספר הגרסה של הפורטל.
   4. מחלצים את התוכן של קובץ ה-‎ .tar של Developer Channel Services באמצעות הפקודה:
      > tar -xvf <tar file>
   5. עוברים אל DeveloperServices-4.x.y.z.
   6. יוצרים את קובץ ה-‎ .tar.gz של הפורטל באמצעות הפקודה:
      > ‎./non-networked-install.sh
      
      הפקודה הזו מורידה את כל הקבצים הנדרשים ומכניסה אותם לקובץ ‎ .tar.gz אחד. לאחר מכן, מעתיקים את קובץ ה-‎ .tar.gz לשרת שאין לו חיבור לאינטרנט כדי להשלים את ההתקנה.
4. כדי לבדוק את החיבור לשרת הניהול של Edge, מריצים את פקודת ה-cURL הבאה משורת הפקודה בשרת הפורטל:
   > curl -u {EMAIL}:{PASSWORD} https://{hostname}:8080/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"
   }

3. התקנת Developer Channel Services באמצעות סקריפט ההתקנה האוטומטי

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

1. מתחברים לשרת כמשתמש root או כמשתמש-על.
2. יוצרים ספרייה לקובצי ההתקנה, למשל portal.
3. בשרת עם חיבור לאינטרנט:
   1. עוברים לספריית הפורטל החדשה ומורידים את הקובץ DeveloperServices_x.y.z.tar של Developer Channel Services, כאשר x.y.z תואם למספר הגרסה של הפורטל.
      
      אפשר להוריד קובץ מהקישור ש-Apigee שלחה בדפדפן, או להעתיק אותו ולהוסיף אותו לפקודת ה-cURL הבאה:
      > curl -kOL <paste link here>
   2. מחלצים את התוכן של קובץ ה-‎ .tar של Developer Channel Services באמצעות הפקודה:
      > tar -xvf <tar file>
   3. עוברים אל DeveloperServices-4.x.y.z.
   4. מריצים את סקריפט ההתקנה באמצעות הפקודה הבאה:
      > ‎./networked-install.sh
4. בשרת ללא חיבור לאינטרנט:
   1. מעתיקים את קובץ ה-‎ .tar.gz שיצרתם בסעיף 2 למעלה. מוודאים שהמערכת עומדת בדרישות המערכת.
   2. מחלצים את התוכן של קובץ ה-‎ .tar.gz באמצעות הפקודה:
      > tar -xvf <tar file>
   3. משנים את הספרייה (CD) לספרייה שנוצרה על ידי הפקודה tar.
   4. מגדירים את ההרשאות בסקריפט install-from-rpm-bundle.sh:
      > chmod 755 install-from-rpm-bundle.sh
   5. מריצים את הסקריפט install-from-rpm-bundle.sh באמצעות הפקודה:
      > ./install-from-rpm-bundle.sh
5. עונים על השאלות.
6. בסיום ההתקנה, עוברים לכתובת ה-URL של השרת בדפדפן, למשל:
   http://localhost. לחלופין, אם הגדרתם כתובת IP או DNS ספציפיים, עברו אל http://IP_address או אל http://DNS_name.
   
   המערכת תפנה אתכם לדף Database configuration בפרופיל Apigee.
   
   הערה: בדרך כלל, כבר הגדרתם שם מארח ורשמתם אותו בשרת ה-DNS, כך שאתם לא צריכים להשתמש ב-http://localhost.
7. מגדירים את החיבור ל-MySQL. אם MySQL נמצא במכונה מרוחקת, מרחיבים את הקטע Advanced Options ומזינים את פרטי החיבור למכונה הזו, ואז לוחצים על Save and continue.
8. מגדירים את החיבור לנקודת הקצה של Apigee על ידי הזנת הפרטים הבאים, ואז לוחצים על Save:
   מידע נוסף על הערכים האלה זמין בקטע Information Required Before You Start the Install במאמר Developer Services portal requirements.
   1. Dev Portal Org
   2. כתובת ה-URL של נקודת הקצה (endpoint) בפורטל המפתחים
   3. משתמש מאומת בנקודת קצה (endpoint)
   4. סיסמה של משתמשים מאומתים
9. כשמוצגת בקשה, לוחצים על הכפתור Install Sample SmartDocs WADL כדי להתקין את ה-WADL לדוגמה של SmartDocs. אם תדלגו על השלב הזה, ממשק ה-API לדוגמה של SmartDocs לא יופיע בפורטל.
   הערה: אם הפורטל שלכם מתחבר להתקנה של Apigee Edge for Private Cloud, ולהתקנה הזו של Edge אין חיבור חיצוני לאינטרנט, תצטרכו לבצע הגדרה נוספת של מודול SmartDocs לפני שתוכלו להשתמש ב-SmartDocs. מידע נוסף על SmartDocs זמין בכתובת http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
10. קובעים את הגדרות שרת ה-SMTP. כדי לשלוח הודעות אימייל מהפורטל, צריך להגדיר שרת SMTP ב-Apigee.
    מידע נוסף זמין בכתובת http://apigee.com/docs/developer-services/content/configuring-email.
11. מגדירים את המשתמש האדמין על ידי הזנת הפרטים הבאים, ואז לוחצים על Save. שימו לב ש-Drupal יוצרת משתמש עם הרשאת אדמין בשם admin כברירת מחדל, אז אל תשתמשו ב-admin כשם המשתמש.
    אם מדלגים על השלב הזה, עדיין אפשר להשתמש ב-Drush כדי ליצור אדמין, כמו שמתואר בשלב 4 בהמשך. יוצרים משתמש עם הרשאת אדמין.
    1. השם הפרטי ושם המשפחה של המפתח
    2. שם המשתמש בפורטל למפתחים
    3. סיסמה
    4. כתובת אימייל
12. בסיום ההתקנה, מגדירים את ההרשאות בקובץ settings.php:
    > chmod 640 /var/www/html/sites/default/settings.php
13. עוברים לדף הבית של הפורטל בכתובת http://localhost/ או לשם ה-DNS של הפורטל.
14. מתחברים לפורטל באמצעות פרטי הכניסה של האדמין.

4. יצירת משתמש עם הרשאת אדמין

משתמשים ב-Drush כדי ליצור משתמש עם הרשאת אדמין להתקנה של Developer Channel Services. כברירת מחדל, Drupal יוצר באופן אוטומטי משתמש עם הרשאת אדמין בשם "admin", אז אל תשתמשו ב-"admin" כשם המשתמש.

1. עוברים לספרייה drupal_root/sites/default. המיקום הרגיל של תיקיית השורש של Drupal הוא ‎ /var/www/html:
   > cd <drupal_root>/sites/default
2. מוודאים שיש לכם הרשאות כתיבה בקובצי Drupal הפרטיים:
   > drush vget file_private_path
   
   הפקודה הזו מחזירה את הנתיב לקובצי Drupal הפרטיים, לדוגמה:
   file_private_path: 'sites/default/private'
   
   תואם ל-‎ /var/www/html/sites/default/private/‎. כדי לוודא שהבעלים והקבוצה יכולים לכתוב בספרייה הזו, משתמשים בפקודה הבאה:
   chmod -R g+w dirPathAndName
   chmod -R o+r dirPathAndName
3. מזינים את הפקודות הבאות כדי ליצור משתמש עם הרשאת אדמין, ומחליפים את הפקודות ב-"< >" בערכים שלכם:
   > drush user-create <username> --mail="<email-address>" --password="<password>"
   > drush user-add-role Administrator <username>
4. מתחברים לפורטל למפתחים כאדמין באמצעות שם המשתמש והסיסמה שצוינו למעלה.

5. הגדרת סיסמת הבסיס של MySQL

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

כדי להגדיר את סיסמת הבסיס (root), משתמשים בפקודה הבאה:

> mysqladmin -u root password NEWPASSWORD

אם כבר הגדרתם את סיסמת הבסיס ואתם רוצים לשנות אותה, השתמשו בפקודה הבאה:

> mysqladmin -u root -p'OLDPASSWORD' password NEWPASSWORD

צריך גם לעדכן את הסיסמה בקובץ /var/www/html/sites/default/settings.php.

6. מוודאים שהמודול Update manager מופעל.

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

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

> drush pm-info update

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

7. אופציונלי – פריסה בשרת ייצור

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

1. מריצים את הסקריפט הבא כדי לאבטח את ההתקנה של MySQL:
   > /usr/bin/mysql_secure_installation
   
   הסקריפט הזה מגדיר את סיסמת הבסיס ומאפשר להגביל את הגישה של הבסיס רק ל-localhost, ולהסיר את מסדי הנתונים לבדיקה ואת המשתמש הלא רשום שנוצר כברירת מחדל. מומלץ מאוד להריץ את הסקריפט הזה בשרתי ייצור.
2. אם המדיניות של הארגון מחייבת, מפעילים ומגדירים את SELinux.

8. אופציונלי – הגדרת מנוע החיפוש Apache Solr

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

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

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

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

9. אופציונלי – התקנת mod_ssl לתמיכה ב-HTTPS

מודול mod_ssl משמש את שרת Apache HTTP כדי להציג דפי אינטרנט באמצעות HTTPS. אם רוצים להשתמש ב-HTTPS, משתמשים בפקודה הבאה כדי להתקין את mod_ssl:

> yum install mod_ssl

מידע נוסף על הגדרת הפורטל לשימוש ב-SSL זמין בכתובת http://apigee.com/docs/developer-services/content/using-ssl-portal.

10. אופציונלי – התקנת SmartDocs

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

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

מידע נוסף על SmartDocs זמין במאמר שימוש ב-SmartDocs לתיעוד ממשקי API.

11. מה עכשיו?

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

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