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

Edge for Private Cloud גרסה 4.18.01

לפני ההתקנה, חשוב לוודא את הפרטים הבאים:

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

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

סקירה כללית בנושא התקנה

אחרי שמתקינים את כלי השירות 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

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

הוצאה משימוש של מאפיין 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=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 

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

מסירים את חבילות ה-PHP באמצעות הפקודה הבאה:

yum remove package-name

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 configFile

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

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

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

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

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

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

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

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 כולל את כל מידע על הגדרה, עיצוב וניהול של פורטל. אפשר לגשת לתיעוד בכתובת http://apigee.com/docs/developer-services/content/what-developer-portal.

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

משימה תיאור

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

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

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

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

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

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

הגדרה אימייל

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

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

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

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

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

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

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

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

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

הערה: המודול 'גיבוי והעברה' לא תואם ל-Postgres מסדי נתונים.

ראו גם איך לבצע גיבוי.

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

אם לא תגדיר שם מארח בשרת ה-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 משלכם כפי שמתואר בהסבר על מודול ומעבירים את המודול ל/sites/all/modules