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

Edge for Private Cloud גרסה 4.17.05

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

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

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

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

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

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

# 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

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

yum remove <package-name>

3. התקנת Postgres

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

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

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

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

  1. התקנת כלי השירות apigee-setup בצומת באמצעות או תהליך אחר שהוא לא אינטרנט. בהתקנת כלי ההגדרה של 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)

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

    # מגדירים את הסיסמה של Postgres. ערך ברירת המחדל הוא 'postgres'.
    PG_PWD=postgres
  3. בשורת הפקודה, מריצים את סקריפט ההגדרה כדי להתקין את Postgres:
    &gt; /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. מתחברים לפורטל באמצעות פרטי הכניסה של האדמין שנקבעו בהגדרות האישיות חדש.

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

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

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

> drush pm-info update

צריך להריץ את הפקודה הזו מהספרייה ברמה הבסיסית (root) של האתר. כברירת מחדל, הפורטל מותקן בכתובת /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 בפורטל Developer Services באופן שמאפשר לכם להשתמש במסמכי התיעוד של ה-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' זמין בכתובת https://www.drupal.org/project/jquery_update.

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

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

9. מה הדבר הבא?

אחרי שתתקינו את פורטל 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/wwwroot/sites/default.

פיתוח בהתאמה אישית אפשר גם להרחיב את היכולות של הפורטל באמצעות קוד מותאם אישית מחוץ לעיצוב. לשם כך, צריך ליצור מודול Drupal משלכם כמו שמתואר במודול של Drupal ולהציב את המודול ב/sites/all/modules