התקנת הפורטל

לפני שמתקינים את פורטל Apigee Developer Services (או פשוט את הפורטל), צריך לוודא את הדברים הבאים:

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

מנהל ההתקנה כולל רק מודולים שהותקנו על ידי Drupal שנדרשים על ידי פורטל השירותים למפתחים של Apigee (או פשוט, הפורטל). למידע על התקנת מודולים אחרים שנוספו, ראו Extending Drupal 7.

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

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

  1. בדיקת החיבור
  2. הסרת גרסאות של PHP לפני גרסה 7.0
  3. התקנת Postgres
  4. התקנת הפורטל
  5. חשוב לוודא שמנהל העדכונים מופעל
  6. (אופציונלי) הגדרת Apache Solr
  7. (אופציונלי) התקנת SmartDocs
  8. (אופציונלי) הגדרת JQuery

הוצאה משימוש של נכס SMTPSSL

בגרסאות הקודמות השתמשת במאפיין SMTPSSL כדי להגדיר את הפרוטוקול המשמש את שרת ה-SMTP שמחובר לפורטל. הנכס הזה הוצא משימוש.

עכשיו עליך להשתמש במאפיין SMTP_PROTOCOL, במקום במאפיין SMTPSSL, כדי להגדיר את הפרוטוקול המשמש את שרת ה-SMTP שמחובר לפורטל. הערכים החוקיים הם: standard , ssl או tls.

יצירת קובץ תצורה של פורטל

למטה מוצג קובץ תצורה שקט לדוגמה להתקנת פורטל. עורכים את הקובץ הזה לפי הצורך בהגדרות האישיות שלכם. כדי לכלול את הקובץ הזה צריך להשתמש באפשרות -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=PORTAL_ADMIN_PASSWORD
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=ORG_ADMIN_PASSWORD

# The PHP port.
# If omitted, it defaults to 8888.
PHP_FPM_PORT=8888

# Optionally configure the SMTP server used by the portal.
# If you do, 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

# Set the SMTP protocol as "standard", "ssl", or "tls",
# where "standard" corresponds to HTTP.
# Note that in previous releases, this setting was controlled by the
# SMTPSSL property. That property has been deprecated.
SMTP_PROTOCOL="standard"

# 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=YOUR_EMAIL_PASSWORD

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.

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

{
  "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

אם אתם לא בטוחים אם PHP מותקן בשרת שלכם, השתמשו בפקודה הבאה:

rpm -qa | grep -i php

שימו לב שהפורטל משתמש ב-PHP בגרסה 4.18.01-0.0.49. המספר הזה לא אמור להיות זהה למספר הגרסה של Apigee Edge לענן פרטי.

3. התקנת Postgres

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

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

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

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

  1. מתקינים את כלי העזר apigee-setup של Edge בצומת באמצעות הליך אינטרנט או ללא חיבור לאינטרנט. למידע נוסף, אפשר לקרוא את המאמר התקנת כלי ההגדרה של Edge apigee.
  2. יוצרים קובץ תצורה של Postgres, כמו בדוגמה הבאה: 
    # Must resolve to IP address or DNS name of host - not to 127.0.0.1 or localhost
HOSTIP=$(hostname -i)

# The pod and region of Postgres. Use the default values shown below.
MP_POD=gateway
REGION=dc-1

# Set the Postgres password. The default value is 'postgres'.
PG_PWD=postgres
  3. בשורת הפקודה, מריצים את סקריפט ההגדרה כדי להתקין את Postgres: 
    /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f postgres_config_file

    האפשרות -p pdb מציינת להתקין את Postgre. קובץ התצורה צריך להיות נגיש או קריא למשתמש "apigee".

4. התקנת הפורטל

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

  1. התקנת כלי השירות Edge apigee-setup בצומת הפורטל
  2. התקנת Postgres, בנפרד או כחלק מהתקנת Edge

כדי להתקין את הפורטל:

  1. בשורת הפקודה, מריצים את הסקריפט setup: 
    /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

    כאשר:

    • configFile הוא קובץ התצורה של הפורטל, כמו שמתואר במאמר יצירת קובץ תצורה של פורטל.
    • -p dp מורה לסקריפט setup להתקין את הפורטל.

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

  1. עוברים אל דף הבית של הפורטל בכתובת http://localhost:8079 או אל שם ה-DNS של הפורטל.
  2. מתחברים לפורטל באמצעות פרטי הכניסה של האדמין שהגדרתם בקובץ התצורה של הפורטל.
  3. כדי לוודא שאפשר לראות את הסטטוס הנוכחי של הפורטל, בוחרים באפשרות Reports > Status Report (דוחות > דוח סטטוס) בתפריט Drupal.
  4. מוודאים שהחיבור לשרת הניהול בוצע בהצלחה. אם לא:
    1. נכנסים לדף 'הגדרת החיבור' בפורטל (לדוגמה, http://portal_IP:8079/admin/config/devconnect).
    2. לוחצים על הלחצן בדיקת החיבור. אם החיבור מצליח, סיימת. אם החיבור נכשל, ממשיכים.
    3. בודקים את הגדרות נקודת הקצה ואת הגדרות האימות:
      • כתובת ה-URL של נקודת הקצה של ה-API לניהול: צריך לבדוק שהפרוטוקול (HTTP או HTTPS), שם ה-IP או ה-DNS ומספר היציאה נכונים. לדוגמה: 
        http://10.10.10.10:8080/v1
      • משתמש מאומת של נקודת קצה (endpoint): שם המשתמש של מנהל הארגון.
      • סיסמה של משתמש מאומת: הסיסמה של מנהל הארגון.

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

      הערכים האלה אמורים להתאים לערכים ms_IP_or_DNS, email ו-password שבהם השתמשתם בשלב 1: בדיקת החיבור ל-Apigee Edge. שם המשתמש והסיסמה צריכים גם להתאים לערכים של המאפיינים USER_NAME ו-USER_PWD בקובץ התצורה של הדרכה למשתמשים חדשים, או לפרטי הכניסה של כל משתמש שתפקידו הוא 'אדמין ארגוני'.

    4. אחרי שמתחברים לשרת הניהול, לוחצים על הלחצן Save configuration בחלק התחתון של הדף כדי לשמור את השינויים.

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 (אופציונלי)

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

משימה התיאור

התאמה אישית של העיצוב

העיצוב מגדיר את מראה הפורטל, כולל הצבעים, העיצוב והיבטים ויזואליים אחרים.

התאמה אישית של המראה

דף הבית כולל את התפריט הראשי, הודעת הפתיחה, כותרת עליונה, כותרת תחתונה וכותרת.

הוספה וניהול של חשבונות משתמשים

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

הגדרת האימייל

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

הוספה וניהול של חשבונות משתמשים

יש להוסיף דף תנאים והגבלות שהמפתחים חייבים לאשר כדי לקבל גישה לפורטל.

הוספה וניהול של חשבונות משתמשים

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

הוספת פוסטים בבלוגים ובפורומים

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

לוודא שמתבצע גיבויים של מסדי נתונים

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

למידע נוסף, ראו איך לבצע גיבוי.

הגדרה של שם מארח

אם לא מגדירים שם מארח בשרת ה-DNS, תמיד אפשר לגשת לאתר דרך כתובת ה-IP של השרת. אם רוצים להשתמש בשם מארח, אפשר להגדיר את ה-DNS של השרת, שאמור לפעול כמו שצריך ללא הגדרות אחרות בהגדרה בסיסית.

אם הגדרת מאזן עומסים או אם מתקבלות כתובות URL שגויות באתר מסיבה אחרת כלשהי, אפשר להגדיר את $base_url עבור Drupal באמצעות הפעולות הבאות:

  1. יוצרים את הספרייה /opt/apigee/data/apigee-drupal-devportal/sites/default/includes אם היא לא קיימת.
  2. יוצרים קובץ בשם settings.php בספרייה הזו.
  3. מוסיפים את הטקסט הבא לקובץ settings.php: 
    /**
* Base URL (optional).
*
* If Drupal is generating incorrect URLs on your site, which could
* be in HTML headers (links to CSS and JS files) or visible links
* on pages (such as in menus), uncomment the Base URL statement
* below (remove the leading hash sign) and fill in the absolute URL
* to your Drupal installation.
*
* You might also want to force users to use a given domain.
* See the .htaccess file for more information.
*
* Examples:
*   $base_url = 'http://www.example.com';
*   $base_url = 'http://www.example.com:8888';
*   $base_url = 'http://www.example.com/drupal';
*   $base_url = 'https://www.example.com:8888/drupal';
*
* It is not allowed to have a trailing slash; Drupal will add it
* for you.
*/
# $base_url = 'http://www.example.com/';  // NO trailing slash!
$base_url = ‘http://www.example.com’;
  4. משנים את השורה $base_url האחרונה לשם המארח של האתר.
  5. שומרים את הקובץ.

לתשומת ליבך, ניתן לשמור בקובץ הזה הגדרות אחרות מ-/opt/apigee/data/apigee-drupal-devportal/ sites/default/default.settings.php.

מידע נוסף על הנכס ב-$base_url זמין במאמרים הבאים:
פיתוח מותאם אישית מומלץ גם להרחיב את יכולות הפורטל באמצעות קוד מותאם אישית מחוץ לעיצוב. לשם כך, צריך ליצור מודול Drupal משלך, כפי שמתואר בנושאים שקשורים לפיתוח מודולים ב-Drupal, ולהציב את המודול בספרייה /sites/all/modules.