התקנת הפורטל

Edge for Private Cloud גרסה 4.19.01

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

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

ההתקנה כוללת רק מודולים שנתרמו על ידי Drupal ונדרשים על ידי פורטל שירותי המפתחים של Apigee (או פשוט הפורטל). למידע על התקנת מודולים אחרים שנתרמו, ראו הרחבת 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

שימו לב שהפורטל משתמש בגרסה 4.18.01-0.0.49 של PHP. הוא לא אמור להתאים למספר הגרסה של Apigee Edge for Private Cloud.

3. התקנת Postgres

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

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

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

כדי להתקין את Postgres כרכיב נפרד:

1. מתקינים את כלי השירות של Edge apigee-setup בצומת באמצעות ההליך עם האינטרנט או בלי האינטרנט. למידע נוסף, קראו את המאמר התקנת כלי השירות apigee-setup של Edge.
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, כ-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. בתפריט של Drupal, בוחרים באפשרות Reports > Status Report כדי לוודא שאפשר לראות את הסטטוס הנוכחי של הפורטל.
4. מוודאים שהחיבור לשרת הניהול הצליח. אם לא:
   1. עוברים לדף Connection Configuration (הגדרת החיבור) בפורטל (לדוגמה, http://portal_IP:8079/admin/config/devconnect).
   2. לוחצים על הכפתור בדיקת החיבור. אם החיבור הצליח, סיימתם. אם החיבור נכשל, ממשיכים.
   3. בודקים את ההגדרות של נקודת הקצה והאימות:
      • כתובת ה-URL של נקודת הקצה של Management API: בודקים שהפרוטוקול (HTTP או HTTPS), כתובת ה-IP או שם ה-DNS ומספר היציאה נכונים. לדוגמה:

        http://10.10.10.10:8080/v1

      • משתמש מאומת בנקודת קצה: שם המשתמש של האדמין בארגון.
      • הסיסמה של המשתמש המאומת: הסיסמה של האדמין בארגון.

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

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

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

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

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

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

drush pm-info update

צריך להריץ את הפקודה הזו מתיקיית השורש של האתר. כברירת מחדל, הפורטל מותקן ב-/opt/apigee/apigee-drupal/wwwroot. לכן, לפני שמריצים את הפקודה, צריך קודם לשנות את הספרייה ל-/opt/apigee/apigee-drupal/wwwroot. אם לא התקנתם את הפורטל בספריית ברירת המחדל, עברו לספריית ההתקנה.

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

6. הגדרת מנוע החיפוש 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.

7. התקנת SmartDocs (אופציונלי)

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

• אם אתם מחברים את הפורטל להתקנה של Edge Cloud, ‏ SmartDocs כבר מותקן ואין צורך בהגדרות נוספות.
• אם אתם מחברים את הפורטל להתקנה של Edge for Private Cloud, אתם צריכים לוודא ש-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 (הגדרה > פיתוח > עדכון JQuery).
3. בתפריט הניווט הימני לוחצים על ביצועים.
4. בתפריט הנפתח של JQuery ו-JQuery UI CDN, בוחרים באפשרות None (ללא).
5. לוחצים על שמירת ההגדרה.

9. השלבים הבאים

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