התקנת הפורטל

Edge for Private Cloud גרסה 4.18.05

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

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

מנהל ההתקנה כולל רק מודולים שנוספו על ידי 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

3. התקנת Postgres

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

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

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

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

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

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

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

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

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

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

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

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

8. מגדירים את מודול עדכון JQuery להתקנות לא באינטרנט (אופציונלי)

אם מתקינים את מודול JQuery Update ומשתמשים בו בהתקנה שלא קשורה לאינטרנט, צריך להגדיר את המודול לשימוש בגרסה המקומית של JQuery. אם מגדירים את המודול לשימוש ב-CDN עבור התקנה שאינה באינטרנט, הוא ינסה לגשת ל-CDN ולגרום לעיכובים בדף בטעינה. למידע נוסף על המודול 'עדכון JQuery Update', https://www.drupal.org/project/jquery_update.

כדי להגדיר את המודול של JQuery Update לשימוש בגרסה המקומית של JQuery:

1. מתחברים לפורטל כמשתמשים עם הרשאות אדמין או הרשאות ליצירת תוכן.
2. בוחרים באפשרות הגדרה > פיתוח > JQuery Update בתפריט Drupal.
3. בתפריט הניווט הימני, לוחצים על ביצועים.
4. בתפריט הנפתח של JQuery ו-JQuery UI CDN, בוחרים באפשרות ללא.
5. לוחצים על Save configuration (שמירת ההגדרות האישיות).

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

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