דף זה תורגם על ידי Cloud Translation API.

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

Edge for Private Cloud v. 4.17.01

לפני שמתקינים, חשוב לוודא:

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

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

אחרי שמתקינים את הכלי apigee-setup בצומת, משתמשים באותו כלי כדי להתקין את הפורטל בצומת. הפורמט של הכלי apigee-setup הוא:

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p component -f configFile

מעבירים קובץ תצורה לכלי apigee-setup שמכיל את המידע על ההתקנה. אם חסר מידע נדרש בקובץ התצורה, הכלי apigee-setup יבקש ממכם להזין אותו בשורת הפקודה.

הדרישה היחידה היא שקובץ התצורה יהיה נגיש או קריא למשתמש 'apigee'.

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

> sudo /opt/apigee/apigee-setup/bin/setup.sh -p dp -f myConfig

מידע נוסף זמין במאמר התקנה של הכלי apigee-setup ב-Edge.

יצירת קובץ תצורה

בהמשך מוצג קובץ תצורה לדוגמה להתקנה של פורטל ללא תצוגה. עורכים את הקובץ הזה לפי הצורך בהתאם לתצורה שלכם. כדי לכלול את הקובץ הזה, משתמשים באפשרות -f ב-setup.sh.

הערה: אין להגדיר את DEVPORTAL_ADMIN_USERNAME=admin. חשבון המשתמש admin נוצר כברירת מחדל. אם מצוין שם משתמש, תופיע הודעת שגיאה עם בקשה להגדיר שם משתמש אחר.

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=pWord 
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=pWord 

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

# You must configure the SMTP server used by the portal. 
# 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 

# Use SSL for SMTP: 'y' or 'n' (default). 
SMTPSSL="n" 

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

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}.

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

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

ב-CentOS וב-RedHat Enterprise Linux‏ (RHEL), מסירים את חבילות ה-PHP באמצעות הפקודה הבאה:

yum remove <package-name>

3. התקנת Postgres

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

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

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

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

מתקינים את הכלי apigee-setup של Edge בצומת באמצעות ההליך באינטרנט או בלי אינטרנט. מידע נוסף זמין במאמר התקנה של הכלי apigee-setup ב-Edge.
יוצרים קובץ תצורה ל-Postgres, כפי שמתואר בהמשך:

# ה-pod והאזור של Postgres. משתמשים בערכים שמוגדרים כברירת מחדל כפי שמתואר בהמשך.
MP_POD=gateway
REGION=dc-1

# מגדירים את הסיסמה ל-Postgres. ערך ברירת המחדל הוא 'postgres'.
PG_PWD=postgres
בשורת הפקודה, מריצים את סקריפט ההגדרה כדי להתקין את Postgres:
> /opt/apigee/apigee-setup/bin/setup.sh -p pdb -f configFile

האפשרות '-p pdb' מציינת התקנה של Postgres.

קובץ התצורה צריך להיות נגיש או קריא למשתמש ה-apigee.

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

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

מתקינים את הכלי apigee-setup של Edge בצומת באמצעות האינטרנט או באמצעות תהליך ללא אינטרנט. מידע נוסף זמין במאמר התקנה של הכלי apigee-setup ב-Edge.
מוודאים שהתקנתם את Postgres, ש-Postgres בנפרד או כחלק מהתקנת Edge.
מריצים את סקריפט ההגדרה בשורת הפקודה:
> /opt/apigee/apigee-setup/bin/setup.sh -p dp -f configFile

האפשרות '-p dp' מציינת התקנה של הפורטל.

משתמש apigee צריך להיות מסוגל לגשת לקובץ התצורה או לקרוא אותו.
עוברים אל דף הבית של הפורטל בכתובת http://localhost:8079 או אל שם ה-DNS של הפורטל.
מתחברים לפורטל באמצעות פרטי הכניסה של האדמין שהגדרתם בקובץ התצורה.

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

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

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

> drush pm-info update

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

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

6. הגדרת מנוע החיפוש Apache Solr (אופציונלי)

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

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

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

מתחברים לפורטל כמשתמשים עם הרשאות אדמין או הרשאות ליצירת תוכן.
בתפריט Drupal, בוחרים באפשרות Modules.
מפעילים את המודול Apache Solr Framework ואת המודול Apache Solr Search.
שומרים את השינויים.
מגדירים את 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. מה הדבר הבא?

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

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

משימה	תיאור
התאמה אישית של העיצוב	העיצוב קובע את המראה של הפורטל, כולל צבעים, סגנון ותכונות חזותיות אחרות.
התאמה אישית של המראה	דף הבית כולל את התפריט הראשי, הודעת הפתיחה, הכותרת, הכותרת התחתונה והשם.
הוספה וניהול של חשבונות משתמשים	תהליך הרישום קובע איך מפתחים חדשים יירשמו לחשבון בפורטל. לדוגמה, האם מפתחים חדשים מקבלים גישה מיידית לפורטל, או שהם צריכים לעבור אימות על ידי אדמין. התהליך הזה קובע גם איך האדמין של הפורטל יקבל הודעה כשיוצרים חשבון חדש.
הגדרת אימייל	המערכת שולחת אימיילים בתגובה לאירועים מסוימים. לדוגמה, כשמפתח חדש מת registrar בפורטל, וכשמפתח מאבד את הסיסמה שלו.
הוספה וניהול של חשבונות משתמשים	מוסיפים דף תנאים והגבלות שהמפתחים צריכים לאשר כדי לקבל גישה לפורטל.
הוספה וניהול של חשבונות משתמשים	בפורטל מוטמע מודל הרשאה מבוסס-תפקיד. לפני שמאפשרים למפתחים להירשם, צריך להגדיר את ההרשאות והתפקידים שבהם הפורטל משתמש.
הוספת פוסטים בבלוג ובפורומים	בפורטל יש תמיכה מובנית בבלוגים ובפורומים עם שרשור. להגדיר את ההרשאות שנדרשות כדי להציג, להוסיף, לערוך ולמחוק פוסטים בבלוג ובפורום.
לוודא שמבצעים גיבויים של מסד נתונים	חשוב לוודא שגיביתם את מסד הנתונים של Drupal. חשוב לזכור שכל התקנה היא שונה, ולכן אתם צריכים לקבוע איך הכי טוב לגבות את מסד הנתונים. הערה: המודול גיבוי והעברה לא תואם למסדי נתונים של Postgres. אפשר גם לעיין במאמר איך מבצעים גיבוי.
הגדרת שם מארח	אם לא תגדירו שם מארח בשרת ה-DNS, תמיד תוכלו לגשת לאתר דרך כתובת ה-IP של השרת. אם רוצים להשתמש בשם מארח, אפשר להגדיר DNS לשרת, שאמור לפעול בצורה תקינה ללא הגדרות נוספות של הגדרה בסיסית. אם הגדרתם מאזן עומסים או אם מופיעות כתובות URL שגויות באתר מסיבה אחרת, תוכלו להגדיר את $base_url בקובץ settings.php של Dev Portal, שנמצא כברירת מחדל בספרייה /opt/apigee/apigee-drupal/sites/default.
פיתוח בהתאמה אישית	אפשר גם להרחיב את היכולות של הפורטל באמצעות קוד מותאם אישית מחוץ לעיצוב. כדי לעשות זאת, יוצרים מודול Drupal משלכם כפי שמתואר בנושאים של פיתוח מודול ב-Drupal, ומכניסים את המודול לתיקייה `/sites/all/modules`.