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

פורטל השירותים למפתחים גרסה 4.16.05

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

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

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

עוברים אל http://community.apigee.com/content/apigee-customer-support. ובוחרים באפשרות 'התחברות לפורטל התמיכה' כדי לבקש את קובץ ה- .tar של הפלטפורמה למפתחים אחת משתי הדרכים הבאות:

• מבקשים גישה לספריית ההורדות של Edge for Private Cloud.
• מבקשים כתובת URL לקובץ .tar של שירותי הערוצים למפתחים.

2. הקפדה על תאימות המערכת דרישות

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

1. יש לוודא שאתם מבצעים את ההתקנה בגרסת 64 סיביות של גרסה נתמכת של Red Hat Enterprise Linux , CentOS או Oracle. כאן אפשר לעיין ברשימת הגרסאות הנתמכות.
2. מוודאים ש-Yum מותקנת.
3. (בהתקנה בשרת ללא חיבור לאינטרנט) צריך להוריד קודם את כל הקבצים הנחוצים לשרת עם חיבור לאינטרנט קובץ .tar.gz לאחר מכן, יש להעתיק את קובץ ה- .tar.gz לשרת ללא חיבור לאינטרנט כדי מבצעים את ההתקנה.
   1. מתחברים לשרת עם חיבור לאינטרנט ברמה הבסיסית (root) או כמשתמש-על.
   2. יוצרים ספרייה לקובצי ההתקנה, למשל portal_tar.
   3. את ה-CD לספרייה החדשה ומורידים את DeveloperServices_x.y.z.tar של Developer Channel Services כאשר x.y.z תואם למספר הגרסה של הפורטל.
   4. מחלצים את התוכן של קובץ .tar של הערוץ למפתחים באמצעות פקודה:
      &gt; tar -xvf <tar file&gt;
   5. תקליטור ל-DeveloperServices-4.x.y.z.
   6. יוצרים את קובץ .tar.gz של הפורטל באמצעות הפקודה:
      &gt; ./non-networked-install.sh
      
      הפקודה הזו מורידה את כל הקבצים הדרושים לקובץ .tar.gz אחד. שלך מעתיקים את קובץ ה- .tar.gz לשרת שלכם שאין לו חיבור לאינטרנט כדי להשלים את הפעולה להתקנה.
4. בודקים את החיבור לשרת ניהול Edge על ידי הרצת פקודת ה-cURL הבאה משורת פקודה בשרת הפורטל:
   &gt; 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,
   'נוצר על ידי' : "שם משתמש",
   &quot;displayName&quot; : "cg",
   'סביבות' : [ "test", "prod" ],
   "lastChangeAt" : 1348689232699,
   'lastlastBy' : "foo@bar.com",
   "name" : "cg",
   מאפיינים : {
   'מאפיין' : [ ]
   },
   'type' : "trial"
   }

3. התקנת המפתח שירותי ערוצים שמשתמשים בסקריפט ההתקנה האוטומטית

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

1. מתחברים לשרת ברמה הבסיסית (root) או כמשתמש-על.
2. יוצרים ספרייה לקובצי ההתקנה, כמו portal.
3. בשרת עם חיבור לאינטרנט:
   1. CD אל הפורטל החדש ומורידים את 'שירותי ערוצים למפתחים' DeveloperServices_x.y.z.tar כאשר x.y.z תואם למספר הגרסה של הפורטל.
      
      אפשר להוריד קובץ מהקישור שנשלח אליך על ידי Apigee בדפדפן או על ידי העתקה שלו ולאחר מכן מוסיפים אותו לפקודת ה-cURL הבאה:
      &gt; curl -kOL <paste link [הדבקת קישור] here&gt;
   2. מחלצים את התוכן של קובץ .tar של הערוץ למפתחים באמצעות פקודה:
      &gt; tar -xvf <tar file&gt;
   3. תקליטור ל-DeveloperServices-4.x.y.z.
   4. מריצים את סקריפט ההתקנה באמצעות הפקודה הבאה:
      &gt; ./networked-install.sh
4. בשרת ללא חיבור לאינטרנט:
   1. מעתיקים את קובץ ה- .tar.gz שיצרתם למעלה בקטע 2. מוודאים שהמערכת עומדת בדרישות דרישות המערכת.
   2. מחלצים את התוכן של קובץ ה- .tar.gz באמצעות הפקודה:
      &gt; tar -xvf <tar file&gt;
   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.
   
   אתם תועברו לדף התצורה של מסד הנתונים של פרופיל Apigee.
   
   הערה: בדרך כלל, כבר צריך להגדיר שם מארח ולרשום אותו בשרת ה-DNS, כך שלא תצטרכו להשתמש ב-http://localhost.
7. הגדרת החיבור ל-MySQL. אם MySQL נמצא במחשב מרוחק, מרחיבים את הקטע בקטע אפשרויות מתקדמות ומזינים את פרטי החיבור למחשב הזה, בוחרים באפשרות Save and continue (שמירה והמשך).
8. מגדירים את החיבור לנקודת הקצה (endpoint) של Apigee על ידי הזנת המידע הבא, וגם ואז בוחרים שמירה:
   למידע נוסף על ערכים אלה, ראה "המידע הנדרש לפני התחלת ההתקנה" בפורטל השירותים למפתחים בדרישות שלנו.
   1. ארגון של פורטל המפתחים
   2. כתובת URL של נקודת קצה (endpoint) של פורטל פיתוח
   3. משתמש מאומת של נקודות קצה
   4. משתמשים מאומתים סיסמה
9. כשמופיעה בקשה, לוחצים על הלחצן Install SmartDocs WADL (התקנה לדוגמה של SmartDocs WADL) כדי להתקין. דוגמה ל-SmartDocs WADL. אם תדלגו על השלב הזה, ה-SmartDocs API לדוגמה לא מופיעים בפורטל.
   הערה: אם הפורטל מתחבר להתקנה של Apigee Edge למשתמשים פרטיים וב-Google Cloud, ולהתקנה של Edge אין חיבור חיצוני לאינטרנט, צריך לבצע תצורה נוספת של מודול SmartDocs לפני שתוכל להשתמש ב-SmartDocs. לקבלת מידע נוסף מידע על SmartDocs זמין בכתובת http://apigee.com/docs/developer-services/content/using-smartdocs-document-apis.
10. מגדירים את הגדרות שרת ה-SMTP. ב-Apigee צריך להגדיר שרת SMTP לשליחת הודעות אימייל מהפורטל.
    מידע נוסף זמין בכתובת http://apigee.com/docs/developer-services/content/configuring-email.
11. מגדירים את משתמש האדמין באמצעות הזנת המידע הבא, ואז בוחרים שמירה. לתשומת ליבך, ב-Drupal נוצר משתמש עם הרשאת אדמין בשם '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 כדי ליצור משתמש עם הרשאת אדמין עבור התקנת שירותי הערוצים למפתחים. אפליקציית Drupal יוצרת באופן אוטומטי משתמש עם הרשאת אדמין בשם admin. כברירת מחדל, אין להשתמש במילה 'אדמין' בתור שם משתמש.

1. CD לספריית drupal_root/sites/default. המיקום הסטנדרטי של הרמה הבסיסית (root) של Drupal הספרייה היא /var/www/html:
   &gt; cd &lt;drupal_root&gt;/sites/default
2. עליך לוודא שיש לך הרשאות כתיבה בקובצי ה-Drupal הפרטיים:
   &gt; 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. כדי ליצור משתמש עם הרשאת אדמין, מזינים את הפקודות הבאות, ומחליפים את הפקודות ב-'<' >” עם הערכים שלך:
   &gt; יצירת משתמש ב-drush <username> --mail=&quot;&lt;email-address&gt;&quot; --password=&quot;&lt;password&gt;&quot;
   &gt; אדמין של תפקיד משתמש ב-drush <username>
4. מתחברים לפורטל המפתחים כאדמין באמצעות שם המשתמש והסיסמה שצוינו למעלה.

5. הגדרת הסיסמה לרמה הבסיסית (root) ב-MySQL

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

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

> mysqladmin -u root password NEWPASSWORD

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

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

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

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

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

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

> drush pm-info update

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

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

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

1. מריצים את הסקריפט הבא כדי לאבטח את התקנת MySQL:
   &gt; /usr/bin/mysql_secure_installation
   
   הסקריפט מגדיר את הסיסמה לרמה הבסיסית (root) ומאפשר לכם להגביל את הגישה לרמה הבסיסית בלבד Localhost ולהסיר את מסדי הנתונים לבדיקה ואת המשתמש האנונימי שנוצר כברירת מחדל. אני מריץ את זה מומלץ מאוד לשרתי ייצור.
2. אם הדבר נדרש על פי המדיניות של הארגון, מפעילים ומגדירים את SELinux.

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

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

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

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

1. מתחברים לפורטל כמשתמשים עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בוחרים באפשרות מודולים בתפריט Drupal.
3. הפעל את המודול Apache Solr Framework ואת Apache Solr חיפוש.
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 שלכם בפורטל השירותים למפתחים, כדי מאמרי העזרה של ה-API אינטראקטיביים לגמרי. אבל כדי להשתמש ב-SmartDocs עם הפורטל, קודם כל צריך מתקינים את SmartDocs ב-Edge.

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

למידע נוסף על SmartDocs, ראו שימוש ב-SmartDocs למסמך ממשקי API.

11. מה הדבר הבא?

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

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

משימה	תיאור
התאמה אישית של עיצוב	העיצוב מגדיר את המראה של הפורטל, כולל צבעים, עיצוב ועוד היבטים חזותיים.
להתאים אישית את מראה	דף הבית כולל את התפריט הראשי, הודעת הפתיחה, הכותרת העליונה, הכותרת התחתונה והכותרת.
הוספה ו- ניהול חשבונות משתמשים	תהליך הרישום קובע איך מפתחים חדשים רושמים חשבון בפורטל. לדוגמה, האם מפתחים חדשים מקבלים גישה מיידית לפורטל או האם הם מקבלים אותו חייבים להיות מאומתים על ידי מנהל מערכת. התהליך הזה קובע גם איך פורטל מנהל המערכת מקבל התראה בכל פעם שנוצר חשבון חדש.
הגדרה אימייל	הפורטל שולח אימיילים בתגובה לאירועים מסוימים. לדוגמה, כשמודל חדש נרשם בפורטל וכשמפתח מאבד את הסיסמה.
הוספה ו- ניהול חשבונות משתמשים	הוספת תנאים דף תנאים שהמפתחים צריכים לאשר לפני שהם מקבלים אישור לגשת לפורטל.
הוספה ו- ניהול חשבונות משתמשים	בפורטל מוטמע מודל הרשאה מבוסס-תפקידים. לפני שמאפשרים למפתחים לרשום ולהגדיר את ההרשאות והתפקידים שבהם הפורטל משתמש.
הוספת בלוג ו פוסטים בפורום	הפורטל כולל תמיכה מובנית בבלוגים ובפורומים מחולקים לשרשורים. הגדרת ההרשאות שנדרשים כדי להציג, להוסיף, לערוך ולמחוק פוסטים בבלוגים ובפורומים.
לוודא שמבצעים גיבויים של מסדי נתונים	צריך לוודא שמסד הנתונים של Drupal מגובה. שימו לב שמכיוון שכל שונה, זה תלוי בך לקבוע מהי הדרך הטובה ביותר לגבות את מסד נתונים.
הגדרה של שם מארח	אם לא תגדיר שם מארח בשרת ה-DNS, תמיד תוכל לגשת לאתר דרך כתובת ה-IP של השרת. אם ברצונך להשתמש בשם מארח, ניתן להגדיר DNS עבור בשרת, שאמור לפעול כראוי ללא הגדרות נוספות כלשהן בביצוע הגדרה בסיסית. אם הגדרתם מאזן עומסים או שמתקבלות כתובות URL שגויות באתר שלכם לחלק אחרת, אפשר להגדיר את $base_url בקובץ settings.php של Dev Portal, שנמצא כברירת מחדל בנתיב /var/www/html/sites/default