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

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

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

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

1. הורדה של חבילת Developer Channel Services

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

  • צריך לבקש גישה לספריית ההורדות של Edge עבור ענן פרטי.
  • מבקשים כתובת URL של קובץ ה- .tar של Developer Channel Services.

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

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

  1. צריך לוודא שמתקינים את הדומיין בגרסת 64 ביט של גרסה נתמכת של Red Hat Enterprise Linux, CentOS או Oracle. כאן אפשר לראות את רשימת הגרסאות הנתמכות.
  2. מוודאים ש-Yum מותקן.
  3. (להתקנה בשרת ללא חיבור לאינטרנט) תחילה צריך להוריד את כל הקבצים הנחוצים לשרת עם חיבור לאינטרנט כקובץ .tar.gz אחד. לאחר מכן מעתיקים את קובץ ה- .tar.gz אל השרת ללא חיבור לאינטרנט, כדי לבצע את ההתקנה.
    1. מתחברים לשרת עם חיבור לאינטרנט בתור משתמש הבסיס או כמשתמש-על.
    2. יוצרים ספרייה לקובצי ההתקנה, כמו portal_tar.
    3. CD עם הספרייה החדשה ומורידים את הקובץ DeveloperServices_x.y.z.tar של שירותי הערוץ למפתחים, כאשר x.y.z תואם למספר הגרסה של הפורטל.
    4. מחלצים את התוכן של קובץ ה- .tar של Developer Channel Services באמצעות הפקודה:
      > tar -xvf <tar file>
    5. CD אל DeveloperServices-4.x.y.z.
    6. יוצרים את קובץ ה-portal .tar.gz באמצעות הפקודה:
      > ./non-networked-install.sh

      הפקודה מורידה את כל הקבצים הנחוצים אליהם לקובץ .tar.gz אחד. לאחר מכן, מעתיקים את קובץ ה- .tar.gz הזה לשרת שלכם שאין לו חיבור לאינטרנט כדי להשלים את ההתקנה.
  4. בודקים את החיבור לשרת הניהול של Edge על ידי הרצת פקודת ה-cURL הבאה משורת הפקודה בשרת הפורטל:
    > curl -u {EMAIL}:{password} https://{hostname}:8080/v1/organizations/{ORGNAME}

    כאשר כתובת האימייל ORGNAME והכתובת ORGNAME והאימייל הם ORGNAME

    חשוב לציין את שם המארח ואת מספר היציאה הספציפיים להתקנה של Edge. יציאה 8080 היא יציאת ברירת המחדל שבה נעשה שימוש ב-Edge. " " " "שם המשתמש: " " : " " [ ) ;
    " ; "שם המשתמש: ", "שם המשתמש: "1. " " "שם המשתמש: ", "[שם המשתמש: 11.0" , "[שם] "שם המשתמש: "[דוגמה: 1348689232699,
    " " "propertyBy" :
    " "propertyBy" :
    "











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

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

  1. צריך להתחבר לשרת בתור משתמש בסיס או כמשתמש-על.
  2. יוצרים ספרייה לקובצי ההתקנה, כמו portal.
  3. בשרת עם חיבור לאינטרנט:
    1. CD עם הספרייה החדשה של הפורטל ומורידים את הקובץ DeveloperServices_x.y.z.tar של שירותי הערוצים למפתחים, כאשר x.y.z תואם למספר הגרסה של הפורטל.

      אפשר להוריד קובץ מהקישור שנשלח אליך על ידי Apigee בדפדפן או על ידי העתקת הקובץ, לאחר מכן הוספתו לפקודת cURL הבאה:
      > curl -kOL <paste link here>
    2. מחלצים את התוכן של קובץ ה- .tar של Developer Channel Services באמצעות הפקודה:
      > tar -xvf <tar file>
    3. CD אל 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.

    תועברו לדף הגדרת מסד הנתונים של פרופיל Apigee.

    הערה: בדרך כלל, כבר הגדרתם שם מארח ורשמתם אותו בשרת ה-DNS כדי שלא תצטרכו להשתמש ב-http://localhost.
  7. הגדרת החיבור ל-MySQL. אם MySQL נמצא במחשב מרוחק, מרחיבים את הקטע Advanced Options (אפשרויות מתקדמות) ומזינים את פרטי החיבור אל המכונה. לאחר מכן, לוחצים על Save and continue (שמירה והמשך).
  8. מגדירים את החיבור ל-Apigee Endpoint באמצעות הזנה של הפרטים הבאים, ואז בוחרים באפשרות שמירה:
    למידע נוסף על הערכים האלה, קראו את הקטע 'מידע נדרש לפני התחלת ההתקנה' בדרישות של פורטל השירותים למפתחים.
    1. ארגון של פורטל הפיתוח
    2. כתובת URL של נקודת קצה לפורטל למפתחים
    3. משתמש מאומת של נקודת קצה
    4. סיסמאות של משתמשים מאומתים
  9. כשתתבקשו, לחצו על הלחצן Install Sample SmartDocs WADL כדי להתקין את ה-SmartDocs WADL לדוגמה. אם בחרת לדלג על השלב הזה, SmartDocs API לדוגמה לא יופיע בפורטל שלך.
    הערה: אם הפורטל מתחבר להתקנה של Apigee Edge לענן פרטי, ולהתקנה של 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. כדי להגדיר את המשתמש שמוגדר כאדמין, מזינים את הפרטים הבאים ואז לוחצים על 'שמירה'. חשוב לשים לב: Drupal יוצר מנהל מערכת ששמו 'אדמין' כברירת מחדל, לכן אין להשתמש בתור 'אדמין' כשם המשתמש.
    אם מדלגים על השלב הזה, עדיין אפשר להשתמש ב-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 יוצרת אוטומטית מנהל מערכת בשם 'אדמין' כברירת מחדל, לכן אין להשתמש ב 'אדמין' כשם המשתמש.

  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

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

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

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

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

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

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

> drush pm-info update

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

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

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

  1. מריצים את הסקריפט הבא כדי לאבטח את ההתקנה של MySQL:
    > /usr/bin/mysql_secure_installation

    הסקריפט הזה מגדיר את סיסמת root ונותן לכם אפשרות להגביל את הגישה ברמה הבסיסית (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 Search.
  4. שומרים את השינויים.
  5. מגדירים את ה-Solr כפי שמתואר בכתובת https://drupal.org/node/1999280.

9. אופציונלי - יש להתקין את mod_ssl כדי לתמוך ב-HTTPS

המודול mod_ssl משמש את שרת ה-HTTP Apache להצגת דפי אינטרנט על גבי 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.