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

Developer Services Portal גרסה 4.16.09

לפני שמתקינים, חשוב לוודא:

• אתם מתקינים את גרסת 64 ביט של גרסה נתמכת של Red Hat Enterprise Linux,‏ CentOS או Oracle. כאן אפשר לראות את רשימת הגרסאות הנתמכות.
• ‫Yum מותקן.
• אתם מגבים את ההתקנות הקיימות. אם שיניתם קוד כלשהו בליבה של Drupal או במודולים לא מותאמים אישית, השינויים שלכם יוחלפו. זה כולל, בין היתר, כל שינוי שביצעתם בקובץ ‎.htaccess. כדאי להניח שכל מה שנמצא מחוץ לספרייה ‎/sites הוא בבעלות Drupal. החריג היחיד לכלל הזה הוא robots.txt. אם הקובץ הזה קיים בתיקיית השורש של האתר, הוא יישמר. לפני שממשיכים בהתקנה, צריך ליצור גיבוי של כל תיקיית השורש של Drupal. מיקום ברירת המחדל להתקנה הוא /var/www/html, אבל יכול להיות ששיניתם אותו בזמן ההתקנה. אחרי שתבצעו את שלבי ההתקנה שמתוארים בהמשך, תוכלו לשחזר את ההתאמות האישיות מהגיבוי.

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

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. בדיקת החיבור ל-Apigee Edge

בודקים את החיבור לשרת הניהול של 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. הסרת גרסאות 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 וב-Red Hat Enterprise Linux‏ (RHEL), מסירים את חבילות ה-PHP באמצעות הפקודה הבאה:

yum remove <package-name>

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

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

בשרת עם חיבור לאינטרנט:

כדי להתקין את Developer Channel Services בשרת עם חיבור לאינטרנט:

1. מתחברים לשרת כמשתמש root או כמשתמש-על.
2. יוצרים ספרייה לקובצי ההתקנה, למשל portal.
3. עוברים לספריית portal החדשה ומורידים את הקובץ DeveloperServices_x.y.z.tar של Developer Channel Services, כאשר x.y.z תואם למספר הגרסה של הפורטל.
   
   אפשר להוריד קובץ מהקישור שנשלח אליכם על ידי Apigee בדפדפן, או להעתיק אותו ואז להוסיף אותו לפקודת ה-cURL הבאה:
   > curl -kOL <paste link here>
4. מחלצים את התוכן של קובץ ה-‎ .tar של Developer Channel Services באמצעות הפקודה:
   > tar -xvf <tar file>
5. ‫CD אל DeveloperServices-4.x.y.z.
6. מריצים את סקריפט ההתקנה באמצעות הפקודה הבאה:
   > ‎./networked-install.sh
7. עונים על ההנחיות.

בשרת בלי חיבור לאינטרנט:

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

1. מתחברים למערכת עם חיבור לאינטרנט כמשתמש-על או כמשתמש בסיסי.
2. יוצרים ספרייה לקובצי ההתקנה, למשל portal_tar.
3. עוברים לספרייה portal_tar ומורידים את הקובץ 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 חדש להתקנה ללא רשת.

1. מתחברים לשרת כמשתמש root או כמשתמש-על.
2. יוצרים ספרייה לקובצי ההתקנה, למשל portal.
3. עוברים לספרייה portal.
4. מעתיקים את הקובץ ‎.tar.gz שיצרתם להתקנה ללא רשת (בתהליך שלמעלה) לספרייה portal.
5. מחלצים את התוכן של קובץ ה-‎.tar.gz באמצעות הפקודה:
   > tar -xvf <tar file>
6. משנים את הספרייה (CD) לספרייה שנוצרה על ידי הפקודה tar.
7. מגדירים את ההרשאות בסקריפט install-from-rpm-bundle.sh:
   > chmod 755 install-from-rpm-bundle.sh
8. מריצים את הסקריפט install-from-rpm-bundle.sh באמצעות הפקודה:
   > ./install-from-rpm-bundle.sh
9. עונים על ההנחיות.

5. הגדרת פורטל המפתחים

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

כדי להגדיר את פורטל המפתחים:

1. עוברים לכתובת ה-URL של השרת בדפדפן, למשל:
   http://localhost. לחלופין, אם הגדרתם כתובת IP או DNS ספציפיים, עברו אל http://IP_address או אל http://DNS_name.
   
   המערכת תפנה אתכם לדף Database configuration בפרופיל Apigee.
   
   הערה: בדרך כלל, כבר הגדרתם שם מארח ורשמתם אותו בשרת ה-DNS, כך שאתם לא צריכים להשתמש ב-http://localhost.
2. מגדירים את החיבור למסד הנתונים. אם מסד הנתונים נמצא במכונה מרוחקת, מרחיבים את הקטע Advanced Options ומזינים את פרטי החיבור למכונה הזו, ואז לוחצים על Save and continue.
3. מגדירים את החיבור לנקודת הקצה של Apigee באמצעות הזנת הפרטים הבאים, ואז לוחצים על Save.
   מידע נוסף על הערכים האלה מופיע בקטע "המידע שנדרש לפני שמתחילים בהתקנה" במאמר הדרישות של פורטל שירותי המפתחים.
   1. Management API Org
   2. כתובת ה-URL של נקודת הקצה של Management API
   3. משתמש מאומת בנקודת קצה (endpoint)
   4. סיסמה של משתמשים מאומתים
4. מגדירים את המשתמש האדמין על ידי הזנת הפרטים הבאים, ואז לוחצים על Save. שימו לב ש-Drupal יוצרת משתמש עם הרשאת אדמין בשם admin כברירת מחדל, אז אל תשתמשו ב-admin כשם המשתמש.
   אם מדלגים על השלב הזה, עדיין אפשר להשתמש ב-Drush כדי ליצור אדמין, כמו שמתואר בשלב 4 בהמשך. יוצרים משתמש עם הרשאת אדמין.
   1. השם הפרטי ושם המשפחה של המפתח
   2. שם המשתמש בפורטל למפתחים
   3. סיסמה
   4. כתובת אימייל
5. בסיום ההתקנה, מגדירים את ההרשאות בקובץ settings.php:
   > chmod 640 /var/www/html/sites/default/settings.php
6. עוברים לדף הבית של הפורטל בכתובת http://localhost/ או לשם ה-DNS של הפורטל.
7. מתחברים לפורטל באמצעות פרטי הכניסה של האדמין.

6. יצירת משתמש עם הרשאת אדמין (אופציונלי)

משתמשים ב-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 שבהם אפשר למצוא מידע נוסף: