אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
ביום שלישי, 8 בספטמבר 2015, השקנו גרסה חדשה של Apigee Edge for Private Cloud.
מאז הגרסה הרבעונית הקודמת של Edge for Private Cloud (4.15.04.00), התרחשו הגרסאות הבאות והן כלולות בגרסה הרבעונית הזו:
לאילו גרסאות של Edge אפשר לשדרג 4.15.07.00
בהתאם לגרסה הנוכחית של Edge, תוכלו:
- שדרוג ישיר ל-4.15.07.00
- שדרוג מצטבר, כלומר צריך לשדרג מהגרסה הנוכחית לגרסה אחרת של Edge, ואז לשדרג לגרסה 4.15.07.00.
מידע נוסף זמין במאמר אילו גרסאות של Edge for Private Cloud אפשר לשדרג לגרסה 4.15.07.00.
לפני השדרוג מגרסה 4.15.01.x או מגרסה קודמת
- בודקים את גרסת SSTable של Cassandra:
- עוברים לספרייה /<install-root>/apigee4/data/cassandra/data.
- מריצים פקודה לחיפוש,
> find . -name *-ic-*
התוצאות אמורות להציג קבוצה של קובצי .db אם אתם מריצים את Cassandra 1.2 SSTable. - מריצים את פקודת החיפוש הבאה:
> find . -name *-hf-*
התוצאות אמורות להיות ריקות, כלומר אין קבצים מסוג db .בפורמט hf. אם לא מופיעים קבצים בפורמט hf, סיימתם את התהליך ועכשיו אתם יכולים לשדרג לגרסה 4.15.07.00.
הפורמט hf מיועד ל-SSTables של Cassandra 1.0. אם יש לכם קובצי *.db בפורמט hf, תצטרכו לשדרג את SSTable כפי שמתואר בהמשך התהליך.
- אם מוצאים קובצי *.db בפורמט hf, צריך לשדרג את SSTable על ידי הרצת הפקודה הבאה בכל צומת של Cassandra עד שמשדרגים את כל הצמתים של Cassandra:
> /<install-root>/apigee4/share/apache-cassandra/bin/nodetool -h localhost upgradesstables -a - חוזרים על שלב 1 כדי לוודא שכל הקבצים עם הסיומת *.db בפורמט ic בגרסה 1.2 של Cassandra.
- חוזרים על שלבים 1 עד 3 בכל צומת של Cassandra בהתקנה של Edge.
- משדרגים את הדפדפן ל-Edge 4.15.07.00.
- אחרי השדרוג לגרסה 4.15.07.00, בודקים את הקבצים עם הסיומת *.db כדי לוודא שכולם שודרגו לסגנון sstable של C* 2.0:
> cd /<install-root>/apigee4/data/cassandra/data
> find . -name *-jb-*
אם אתם משתמשים ב-Cassandra 2.0, הפקודה הזו אמורה להחזיר קבוצה של קובצי db.
תכונות חדשות ושיפורים
בהמשך מפורטים התכונות החדשות והשיפורים בגרסה הזו.
התקנה ושדרוג
שדרוג והסרה של רכיבים נבחרים
הסקריפטים apigee-upgrade.sh ו-apigee-uninstall.sh מאפשרים עכשיו לבחור את רכיבי Edge שרוצים לשדרג או להסיר. בעבר, הוא שדרג או הסיר את כל הרכיבים בצומת. (OPDK-1377, OPDK-1175)
ביטול שדרוג
אם הפקודה apigee-upgrade.sh נכשלת במהלך השדרוג, עכשיו אפשר להשתמש בסקריפט apigee-rollback.sh כדי לבטל את השדרוג. אחרי שתתקנו את הבעיות בשדרוג, תוכלו לנסות שוב לבצע את השדרוג. (OPDK-1275)
אפשרויות מקוצרות של סקריפט ההתקנה
סקריפטים להתקנה לא תומכים יותר באפשרויות ארוכות, כמו --help. עכשיו אפשר להשתמש רק באפשרויות של אות אחת, כמו -h. (OPDK-1356)
התקנה של SmartDocs
כשמתקינים את SmartDocs באמצעות הסקריפט setup-smartdocs.sh, מופיעה בקשה להזין את הארגון, הסביבה והמארח הווירטואלי. כך מוודאים ש-SmartDocs מותקן במיקום הצפוי. בעבר, הערכים האלה היו מוטמעים בסקריפט. (OPDK-1310)
הפעלת update-cass-pwd-in-config.sh ללא הנחיות
אפשר להריץ את הסקריפט update-cass-pwd-in-config.sh בלי הנחיות אם מגדירים את משתני הסביבה ENABLE_CASS_AUTH, CASS_USERNAME ו-CASS_PASSWORD. (OPDK-1309)
Edge Platform
בהמשך מפורטות התכונות החדשות בפלטפורמת Edge שכלולות במהדורה הזו.
OpenJDK 1.7 נתמך על ידי Edge Private Cloud
במהדורה הזו של Edge יש תמיכה ב-Oracle JDK 1.7 וב-OpenJDK 7, והוסרה התמיכה ב-JDK 1.6. (OPDK-1187)
תמיכה במערכת ההפעלה
הוספנו ל-Apigee Edge for Private Cloud תמיכה במערכות ההפעלה Red Hat Enterprise Linux 6.6 ו-7.0 (64 ביט), CentOS 6.5, 6.6 ו-7.0 (64 ביט) ו-Oracle Linux 6.5.
Cassandra 2.0.15 נכללת ב-OPDK 15.07
בגרסה הזו מותקנת Cassandra 2.0.15. אם אתם משדרגים מגרסה קודמת, גרסת Cassandra תתעדכן. (OPDK-1197)
תמיכה ב-SHA2 לגיבוב של אסימוני OAuth
כדי להגן טוב יותר על אסימוני OAuth במקרה של פריצת אבטחה במסד נתונים, Edge תומך באלגוריתמים של SHA2 ליצירת גיבוב של אסימוני OAuth (בנוסף ל-SHA1). בעזרת מאפיינים חדשים ברמת הארגון, תוכלו להפעיל ולהגדיר גיבוב של אסימונים חדשים, וגם לשמור על גיבוב מדור קודם של אסימונים שהיו קיימים לפני התכונה החדשה הזו. בעבר ב-Edge for Private Cloud, המאפיין hash.oauth.tokens.enabled בקובץ keymanagement.properties (בשרת הניהול ובמעבדי ההודעות) הפעיל גיבוב SHA1 אוטומטי של אסימוני OAuth. המאפיין הזה יצא משימוש.
אם השתמשתם בעבר במאפיין hash.oauth.tokens.enabled כדי להפעיל גיבוב SHA1, סקריפט השדרוג של הגרסה הזו ייצור בשבילכם באופן אוטומטי את המאפיינים החדשים ברמת הארגון. כדי לוודא זאת אחרי השדרוג, צריך לבצע בקשת GET כאדמין מערכת באמצעות ה-API הזה: https://{host}:{port}/v1/o/{your_org}.
- מידע על הפעלת גיבוב אסימונים בארגון באמצעות המאפיינים החדשים זמין בקטע 'גיבוב אסימונים במסד הנתונים' שבנושא בקשה לאסימוני גישה.
- מידע על גיבוב בכמות גדולה של אסימונים קיימים זמין במדריך לתפעול של Edge for Private Cloud. (APIRT-1389)
מבנה ספרייה שטוח לקובצי יומן
כדי להגדיר את Edge לשמירת קובצי יומן במבנה ספרייה שטוח, מגדירים את המאפיין החדש enable.flat.directory.structure
כ-true בקובץ message-logging.properties. מידע נוסף זמין במאמר המדיניות בנושא רישום הודעות ביומן.
(APIRT-1394)
ביצועי המטמון של הסביבה
כדי לשפר את הניהול והניצול של המטמון בזיכרון, ההגדרות של 'Maximum Elements in Memory' במשאבי המטמון בסביבה הוצאו משימוש. מספר הפריטים הכולל בכל משאבי המטמון (כולל המטמון שמוגדר כברירת מחדל) תלוי בזיכרון הכולל שהוקצה למטמון. כברירת מחדל, נפח הזיכרון הכולל שהוקצה לאחסון במטמון בזיכרון במעבד הודעות נתון הוא 40% מנפח הזיכרון הכולל שזמין, בהתאם להגדרות של מאפייני המטמון בקובץ cache.properties של מעבד ההודעות. האלמנטים יוסרו מהמטמון בזיכרון רק אם אין מספיק זיכרון מטמון או אם פג התוקף של האלמנטים.
כדי לחזור להתנהגות הישנה של שימוש בנכס 'Maximum Elements in Memory' לניהול המטמון, מגדירים את הנכס overrideMaxElementsInCacheResource=false
בקובץ cache.properties. (APIRT-1140)
שירותי API
בהמשך מפורטות התכונות החדשות של API Services שכלולות במהדורה הזו.
עורך שרת ה-Proxy החדש כברירת מחדל
עורך שרת ה-proxy החדש של ה-API מופעל כברירת מחדל בממשק המשתמש לניהול. העורך החדש כולל שיפורים רבים בנוחות השימוש, כולל תצוגות מקיפות יותר של תהליכים מותנים ונקודות קצה בדף 'סקירה כללית', את כל ההגדרות בדף 'פיתוח', הוספה אינטואיטיבית יותר של תהליכים מותנים, נקודות קצה וכללי מדיניות, תצוגות XML מלאות יותר במקום קטעי קוד קטנים, חיפוש שסורק שמות של קובצי טקסט ועוד. (MGMT-2279)
מדיניות חדשה בנושא מחיקה של מידע ב-OAuth v2.0
מדיניות חדשה בשם 'מחיקת מידע של OAuth v2.0' מאפשרת למחוק אסימוני גישה וקודי הרשאה של OAuth v2. המדיניות מחליפה את הפונקציונליות שסופקה בעבר על ידי ממשק ה-API לניהול. למידע נוסף, ראו מדיניות המחיקה של פרטי OAuthV2. (MGMT-2257)
מדיניות חדשה בנושא מחיקה של פרטי OAuth v1.0
מדיניות חדשה בשם 'מחיקת פרטי OAuth v1.0' מאפשרת למחוק אסימוני בקשה, אסימוני גישה וקודי אימות של OAuth v1.0. המדיניות מחליפה את הפונקציונליות שניתנה בעבר על ידי API הניהול. למידע נוסף, ראו מדיניות המחיקה של פרטי OAuth V1. (APIRT-1351)
מדיניות בקרת גישה
מדיניות בקרת הגישה שודרגה כדי לאפשר הערכה מפורטת יותר של כתובות IP לצורך הוספה לרשימת ההיתרים וההוספה לרשימת הדחייה, כשכתובות ה-IP נכללות בכותרת ה-HTTP X-FORWARDED-FOR
.
כשמפעילים בדיקה של כמה כתובות IP בכותרת (צריך לפנות לתמיכה כדי להגדיר את הערך feature.enableMultipleXForwardCheckForACL), הרכיב החדש <ValidateBasedOn>
במדיניות מאפשר לבדוק את כתובת ה-IP הראשונה, את כתובת ה-IP האחרונה או את כל כתובות ה-IP בכותרת. מידע נוסף זמין במאמר מדיניות בקרת גישה.
ישויות חדשות במדיניות של ישות גישה
מדיניות ישות הגישה מספקת גישה לישויות החדשות הבאות: consumerkey-scopes, authorizationcode, requesttoken ו-verifier. מידע נוסף זמין במאמר מדיניות של ישות גישה.
המדיניות של Statistics Collector: המרה אוטומטית של שם הסטטיסטיקה לאותיות קטנות
כשיוצרים אוסף ניתוח נתונים מותאם אישית בעורך שרת ה-proxy של ה-API (דף Develop > Tools > Custom Analytics Collection), צריך להשתמש באותיות קטנות בשם של משתנה האיסוף (הנתונים הסטטיסטיים) 'Name'. אם מזינים את השם באותיות רישיות, הכלי ממיר את שם הסטטיסטיקה באופן אוטומטי לאותיות קטנות במדיניות של Statistics Collector. (MGMT-740)
הסרה של Classic Trace בעורך proxy ל-API
הגרסה העדכנית ביותר של הפונקציונליות של Trace בעורך שרת ה-proxy של ה-API עברה מגרסת בטא לזמינות כללית. הגישה ל'מעקב 'קלאסי' באמצעות הקישור 'כניסה לגרסה הקלאסית של המעקב' כבר לא זמינה.
גישה לקהילת Apigee מתפריט העזרה של ממשק המשתמש לניהול
אפשר לגשת לקהילת Apigee מתפריט העזרה של ממשק המשתמש לניהול.
הודעות שגיאה בממשק המשתמש לניהול
ריכזנו כאן את השיפורים בהודעות השגיאה בממשק המשתמש לניהול:
- ממשק המשתמש לניהול שבו כל הודעות השגיאה מקובצות ומוצגות בממשק המשתמש במהלך כל סשן ההתחברות, אלא אם דחיתם אותן. בעקבות העדכון הזה, הודעות השגיאה יוסרו באופן אוטומטי כשתנסו לעבור לדף אחר. (MGMT-2254)
- ממשק המשתמש לניהול לא משמיט יותר הודעות שגיאה כפולות. (MGMT-2242)
שיפורים בביצועים ובשגיאות של ממשק המשתמש
ביצענו שיפורים כלליים באזורים שונים בממשק המשתמש לניהול, כולל שיפור בביצועים של הצגת הדפים ושינוי של הודעות השגיאה.
היפר-קישורים של תפקידים בדף 'משתמשים בארגון' בממשק המשתמש לניהול
בדף 'משתמשים בארגון' בממשק המשתמש לניהול ('אדמין' > 'משתמשים בארגון'), שמות התפקידים מחוברים עכשיו לקישור היפר, שמאפשר לנווט במהירות לדפי התפקידים. (MGMT-1055)
משתני יעד חדשים בתהליך שליחת ההודעה
משתנים חדשים בתהליכי העברת ההודעות מספקים מידע מלא יותר על כתובות URL של נקודות קצה ייעודיות ושרתים ייעודיים:
-
TargetEndpoint:
request.url
מחליף אתtarget.basepath.with.query
. -
TargetServer:
loadbalancing.targetserver
מחליף אתtargetserver.name
. בנוסף, השדהtarget.basepath
מאוכלס רק כשמשתמשים באלמנט<Path>
באלמנט<LoadBalancer>
של HTTPTargetConnection ב-TargetEndpoint.
תמיכה ב-Server Name Indication (SNI)
Edge תומך בשימוש ב-Server Name Indication בכיוון דרום (ממעבד ההודעות לנקודות קצה ייעודיות). אם אתם רוצים להשתמש ב-SNI, פנו אל התמיכה של Apigee.
נדרשת Java 1.7.
באמצעות SNI, שהוא תוסף של TLS/SSL, אפשר להציג כמה יעדים של HTTPS מאותה כתובת IP ואותו יציאה, בלי שתצטרכו להשתמש באותו אישור בכל היעדים האלה.
לא נדרשת הגדרה ספציפית ל-Edge. אם הסביבה מוגדרת ל-SNI בכיוון דרום (Edge cloud כברירת מחדל), Edge תומך בכך.
Edge מחלץ באופן אוטומטי את שם המארח מכתובת ה-URL של הבקשה ומוסיף אותו לבקשת לחיצת היד של SSL. לדוגמה, אם מארח היעד הוא https://example.com/request/path, Edge מוסיף את התוסף server_name כפי שמוצג בהמשך:
מידע נוסף על SNI זמין בכתובת http://en.wikipedia.org/wiki/Server_Name_Indication.
'Signature Algorithm' (אלגוריתם חתימה) בפרטי אישורי ה-SSL
נוספ השדה 'Signature Algorithm' (אלגוריתם חתימה) לפרטי אישורי ה-SSL. אפשר לראות אותו בממשק המשתמש לניהול ('אדמין' > 'אישורי SSL') וב-Management API (Get Cert Details from a Keystore or Truststore). בשדה מוצג 'sha1WithRSAEncryption' או 'sha256WithRSAEncryption', בהתאם לסוג אלגוריתם הגיבוב ששימש ליצירת האישור.
הצגת אישורי SSL שפג תוקפם בקרוב
בדף SSL Certificates בממשק המשתמש לניהול (Admin > SSL Certificates), מצוין מתי יפוג התוקף של אישורי ה-SSL בתוך 10, 15, 30 או 90 יום, בהתאם לבחירה שלכם בשדה הנפתח החדש של התוקף.
הגדרת שגיאות של הגנה מפני איומים
כברירת מחדל, אם הודעה לא עוברת מדיניות של Threat Protection בפורמט JSON או XML, Edge יוצר קוד סטטוס HTTP 500 Internal Server Error ושגיאה מסוג ExecutionFailed. אפשר לשנות את התנהגות השגיאה הזו באמצעות נכס חדש ברמת הארגון. כשמגדירים את מאפיין הארגון features.isPolicyHttpStatusEnabled
לערך true, מתרחשת ההתנהגות הבאה:
- בקשה: כשמצרפים מדיניות הגנה מפני איומים לכל תהליך בקשה, הודעות לא חוקיות מחזירות קוד סטטוס 400, יחד עם הודעת שגיאה תואמת מהמדיניות.
- תשובה: כשמצרפים מדיניות של הגנה מפני איומים לכל תהליך תגובה, הודעות לא חוקיות עדיין מחזירות קוד סטטוס 500, ונזרקת אחת מהודעות השגיאה התואמות למדיניות (במקום רק ExecutionFailed).
לקוחות Cloud צריכים לפנות אל התמיכה של Apigee כדי להגדיר את נכס הארגון. התכונה הזו תהיה זמינה ללקוחות Edge Private Cloud במהדורה הרבעונית הבאה של Private Cloud.
סכימות מעודכנות לנקודות קצה, לשרתי proxy ולישויות אחרות
סכימות העזר עודכנו עבור ישויות שאינן קשורות למדיניות, כמו TargetEndpoint, ProxyEndpoint, APIProxy ועוד רבות. מידע נוסף זמין בכתובת https://github.com/apigee/api-platform-samples/tree/master/schemas. (APIRT-1249)
שירותים למפתחים
בהמשך מפורטות התכונות החדשות של Developer Services שכלולות במהדורה הזו.
זמינות כללית של SmartDocs
SmartDocs עובר מגרסת בטא לזמינות כללית. העדכונים והתכונות החדשות כוללים:
- תמיכה ב-Swagger 2.0, כולל ייבוא באמצעות קובץ או כתובת URL, כולל תמיכה באובייקטי אבטחה עם שמות מותאמים אישית.
- שיפורים בעיצוב החזותי של התבניות שמשמשות ליצירת מסמכי SmartDocs.
- שיפורים בממשק המשתמש ובתהליך העבודה בפורטל למפתחים, שזמינים דרך התפריט Content > SmartDocs ב-Drupal.
- האימות שהיה ידוע בתור 'אימות באמצעות טוקן מותאם אישית' נקרא עכשיו 'מפתח API'.
- אובייקטים של 'אבטחה' לאימות שמוגדרים ברמת הגרסה.
- הגדרת אימות לקוח ברמת התבנית. גרסאות חדשות לא מאפסות יותר את פרטי הכניסה של לקוחות SmartDocs שהוגדרו מראש.
תיאור נוסף של התכונות זמין בפוסט הזה בבלוג.
למסמכי העזרה של SmartDocs, ראו שימוש ב-SmartDocs לתיעוד ממשקי API.
שם האפליקציה של המפתח שמוצג בממשק המשתמש לניהול
לאפליקציות של מפתחים ב-Edge יש שם פנימי שלא משתנה ושם מוצג שאפשר לשנות. בדף של אפליקציית הפיתוח בממשק המשתמש לניהול (פרסום > אפליקציות לפיתוח > שם האפליקציה), מוצג 'השם' הפנימי של האפליקציה לצד 'השם המוצג', כך שקל יותר לזהות חזותית אפליקציות לפי השמות הפנימיים שלהן לצורך פתרון בעיות וניהול ממשקי API.
שירותי Analytics
בהמשך מפורטות התכונות החדשות של Analytics Services שכלולות במהדורה הזו.
מועד התפוגה של הנתונים שנשמרו
כשיוצרים דוחות ניתוח נתונים באמצעות ממשק המשתמש לניהול או ממשק ה-API, כברירת מחדל אי אפשר לגשת לנתונים שנאספו לפני יותר משישה חודשים מהתאריך הנוכחי. כדי לגשת לנתונים מלפני יותר משישה חודשים, צריך לפנות אל התמיכה של Apigee.
הגרסה הקלאסית של דוחות בהתאמה אישית תוסר מממשק המשתמש לניהול
הגרסה הקלאסית האופציונלית של דוחות ניתוח נתונים בהתאמה אישית כבר לא זמינה בממשק המשתמש לניהול.
ביצועי הווידג'ט 'מעורבות מפתחים'
הווידג'ט של המשפך במרכז הבקרה הראשי של Analytics (בקטע 'מעורבות מפתחים') שופר כדי לספק ביצועים טובים יותר.
מונטיזציה
בהמשך מפורטות תכונות המונטיזציה החדשות שנוספו לגרסה הזו.
התראות באימייל על תוכניות תמחור
סוג חדש של התראות באימייל לגבי תוכניות תמחור מאפשר לכם להודיע למפתחים כשהם מגיעים למגבלה מסוימת של עסקאות או של סכום דולר בתוכניות התמחור שלהם לפי נפח או בחבילה. למידע נוסף, ראו הגדרת התראות באמצעות תבניות התראות.
סנכרון של תקופות הבסיס של התשלומים הקבועים ושל צבירה
בתוכנית תעריפים, יכול להיות שפעלו שתי תקופות זמן שונות:
- תקופת החיובים הקבועים, שהוגדרה בכרטיסייה 'עמלות' של תוכנית התמחור, קבעה מתי המפתחים חויבו בחיובים קבועים.
- תקופת הבסיס של הצבירה, שמוגדרת בכרטיס התעריפים של תוכניות עם חבילות נפח או חבילות שירות, שמאפשרת לקבוע מתי השימוש בחבילה או בסל שירותים אופס למפתחים.
שתי התקופות האלה מסונכרנות עכשיו. כשקיימים בתוכנית התמחור גם עמלה קבועה שאינה אפס וגם כרטיס תמחור של חבילה או תמחור לפי נפח, תקופת החיוב הקבועה משמשת לשניהם. לדוגמה, אם יש תשלום קבוע חודשי, גם חבילות של כרטיסי תעריף מתאפסים מדי חודש (ברירת המחדל היא בתחילת החודש).
אם אין תשלום קבוע, החבילות מתאפסו על סמך Aggregation Basis שמוגדר בכרטיס התעריפים. לדוגמה, אם מפתח מתחיל להשתמש בכרטיס תעריפים ב-19 בחודש, והבסיס לצבירה הוא מדי חודש, השימוש בחבילה יאפס חודש אחרי ה-19.
האפשרות 'בסיס צבירת נתונים' הוצאה משימוש ותוסר מהמונטיזציה בגרסה עתידית. מידע נוסף זמין במאמר ציון פרטי התוכנית של כרטיס התעריפים.
מאפיינים מותאמים אישית בדוחות סיכום הכנסות
כללי המדיניות של תיעוד העסקאות מאפשרים לכם לתעד נתוני מאפיינים מותאמים אישית מעסקאות, ועכשיו אתם יכולים לכלול את מאפייני העסקאות המותאמים אישית האלה בדוחות סיכום ההכנסות. הוספת המאפיין MINT.SUMMARY_CUSTOM_ATTRIBUTES לארגון מאפשרת לכם לציין אילו מאפיינים מותאמים אישית יתווספו לטבלאות של מסד הנתונים לשימוש בדוחות.
לקוחות Apigee Edge for Private Cloud יכולים להגדיר את הדגל באמצעות הקריאה הבאה ל-API ופרטי הכניסה של האדמין המערכתי.
curl -u email:password -X PUT -H "Content-type:application/xml" http://host:8080/v1/o/myorg -d \ "<Organization type="trial" name="MyOrganization"> <Properties> <Property name="features.isMonetizationEnabled">true</Property> <Property name="MINT.SUMMARY_CUSTOM_ATTRIBUTES">["my_attribute_1","my_attribute_2"]</Property> <Property name="features.topLevelDevelopersAreCompanies">false</Property> </Properties> </Organization>"
שימו לב שהמערך של המאפיינים המותאמים אישית בקריאת ה-API מקודד ככתובת URL.
תהליך השדרוג של SmartDocs
אם כבר השתמשתם ב-SmartDocs במהלך תקופת הבטא, כדי ליהנות מהתכונות והיכולות החדשות בגרסה הזמינה לכולם תצטרכו לשדרג את SmartDocs בפורטל למפתחים.
דפי SmartDocs שכבר פורסמו בפורטל למפתחים ימשיכו לפעול, אבל עליכם לפעול לפי תהליך העדכון לפני שתערכו או תפרסמו שינויים בדפים קיימים או חדשים.
חשוב לזכור שאפשר ליצור ולפרסם SmartDocs בפורטל המפתחים, אבל הם נוצרים מתוך מודל ה-API שנמצא בשירותי ניהול ה-API של Apigee Edge. כל שינוי שתבצעו במודל API ב-Edge יהיה זהה בכל סביבות Pantheon (בדומה לאופן שבו מפתחים קיימים בכל סביבות Pantheon).
איך לשדרג מגרסת הבטא של SmartDocs לגרסה הזמינה לכולם
- מעדכנים ובודקים את הגרסה 15.05.27 בסביבות dev או test ב-Pantheon.
- יוצרים מודל חדש שיחליף את מודל ה-API הקיים שבו השתמשתם.
- אם מייבאים מסמכי Swagger או WADL, צריך לייבא אותם שוב לגרסה חדשה.
- אם טיפלתם במודל ה-API דרך המודול SmartDocs, תוכלו לייצא אותו כ-JSON של SmartDocs ולייבא אותו למודל החדש באמצעות צירוף קובץ.
- מגדירים את מאפייני האבטחה של הגרסה של המודל. בדף תוכן > SmartDocs > דגם, בוחרים באפשרות הגדרות אבטחה.
- בדף ההגדרות של המודל (תוכן > SmartDocs), לוחצים על הגדרות בעמודה Operations כדי לבדוק את פרטי האימות שהוגדרו מראש.
- מעדכנים את התבניות בהתאמה אישית כך שישתמשו בגרסה 6 של נכסי ה-CSS וה-JS, ומבצעים שינויים כך שישקפו את שמות האובייקטים החדשים, כמו authSchemes ו-apiSchema. מידע נוסף על עדכון תבניות של SmartDocs זמין במאמר שימוש ב-SmartDocs לתיעוד ממשקי API.
- מבצעים עיבוד מחדש (re-render) של הגרסה המתוקנת של המודל ומפרסמים אותה.
- אחרי שתאמתו את המסמכים החדשים, עליכם לעדכן את פורטל הייצור לגרסה 15.05.27.
לקוחות Edge Enterprise שיש להם שאלות או חששות לגבי תהליך השדרוג יכולים לשלוח אימייל לכתובות marsh@apigee.com ו-cnovak@apigee.com. לחלופין, אפשר להיעזר בקהילת Apigee כדי לקבל את התשובה הטובה ביותר.
שינויים ושיפורים עתידיים בתכונות
בקטע הזה נספק לכם סקירה מקדימה של השיפורים והשינויים הצפויים בתכונות:
שינוי ההתנהגות של מדיניות Response Cache
בגרסה עתידית (שתיקבע בהמשך), ההתנהגות שמוגדרת כברירת מחדל לרכיב <ExcludeErrorResponse> במדיניות של מטמון התשובות תשתנה.
ההתנהגות הנוכחית: האלמנט <ExcludeErrorResponse> במדיניות המטמון של התשובות הוא false כברירת מחדל. כלומר, כברירת מחדל, תשובות עם כל קוד סטטוס אפשרי של HTTP (כולל 3xx) נשמרות במטמון על ידי המדיניות של Response Cache.
התנהגות עתידית: ברירת המחדל של הרכיב <ExcludeErrorResponse> במדיניות של מטמון התשובות תהיה true. פירוש הדבר הוא שבברירת המחדל, רק תגובות עם קודי סטטוס HTTP 200 עד 205 יישמרו במטמון. כדי לשנות את ההתנהגות הזו ולשמור במטמון תגובות לכל קודי הסטטוס, צריך להגדיר את הרכיב <ExcludeErrorResponse> לערך true באופן מפורש.
פתרון זמני: בגרסאות Private Cloud 4.15.07.00 וגרסאות ישנות יותר, אם רוצים לשמור בתגובה רק תשובות עם קודי הסטטוס 200 עד 205, צריך להגדיר את הרכיב <ExcludeErrorResponse> לערך true.
באגים שתוקנו
בגרסה הזו תוקנו הבאגים הבאים.
מזהה הבעיה | תיאור |
---|---|
OPDK-1521 | בעיה בהצפנת סיסמאות |
OPDK-1201 | לא ניתן לשחזר נתוני ממשק משתמש |
OPDK-1112 | מדיניות סיסמאות LDAP בהתאמה אישית לא חלה על משתמש האדמין של Apigee |
OPDK-1097 | החרגה של מרחבי מפתחות במהלך שדרוג של OPDK |
OPDK-1068 | אפשר לשנות את הסיסמה של האדמין אם היא נכשלת במהלך ההתקנה |
OPDK-1053 | Zookeeper פועל בתור root |
OPDK-967 | כשמגדירים את OpenLDAP להפעלה אוטומטית באמצעות set-autostart.sh, השירות all-status.sh מדווח שהוא לא פועל |
OPDK-905 | Smartdocs prod already registered in group axgroup001 |
OPDK-899 | שגיאה במהלך תהליך ההצטרפות |
OPDK-847 | משתמש שנוצר במהלך תהליך ההצטרפות לא מקבל אימייל לאיפוס הסיסמה |
OPDK-817 | סקריפטים של init.d גורמים לשגיאה |
OPDK-815 | הסקריפט ax-purge.sh מחייב ניקוי של טבלאות דגימה |
MGMT-2246 | הדף 'יצירת דוח בהתאמה אישית' לא מוצג בצורה נכונה בממשק המשתמש לניהול |
MGMT-2235 | במסמכים של אישורי SSL שפג תוקפם, הזמן היחסי של תאריך התפוגה עשוי להיראות מבולבל במסמכים של אישורי SSL שפג תוקפם, הזמן היחסי של תאריך התפוגה מוצג תמיד בימים, במקום להיחשב כחודשים, אם התוקף של האישור פג תוך 90 ימים או פחות. |
MGMT-2193 | סמל טעינה במהלך עריכת ממשק API |
MGMT-2173 | Trace UI לא מאפשר כתובות URL חוקיות מעכשיו, Trace UI מאפשר לשלוח בקשות עם ערכים של פרמטרים של שאילתה שמכילים פרמטרים של שאילתה בתצוגת עץ. |
MGMT-2162 | בעיה ב-JavaScript |
MGMT-2124 | ההרשאות של תפקיד הלקוח מתאפסות כששומרים את ההרשאות בממשק המשתמש |
MGMT-2114 | כתובת IP לא חוקית של Syslog במדיניות MessageLogging אמורה להוביל להודעת שגיאה מתאימה במהלך הפריסה |
MGMT-2067 | Trace: If API proxy revision deployed in 2 environments, selecting revision and environment does not work correctly |
MGMT-2061 | הקישור 'שכחת את הסיסמה?' צריך לשלוח אימיילים רק למשתמשים רשומים הקישור 'שכחת את הסיסמה?' בדף ההתחברות של ממשק הניהול שולח אימיילים רק למשתמשים רשומים ב-Apigee. |
MGMT-2048 | משתמש עם תפקיד בהתאמה אישית שמגביל את הרשאות הפריסה לסביבה אחת יכול לפרוס בסביבות אחרות |
MGMT-2041 | הסרת האלמנט FaultRules מתבנית הקובץ המצורף שמוגדרת כברירת מחדל האלמנט FaultRules, שלא משמש במדיניות או בשלבים של שרת proxy ל-API, לא מתווסף יותר באופן אוטומטי כשיוצרים שרתי proxy ל-API או מוסיפים מדיניות. |
MGMT-2034 | אחזור WSDL מחזיר כשל: "שגיאת אחזור WSDL: שגיאה בעיבוד WSDL" |
MGMT-1986 | שגיאה בממשק המשתמש בזמן הוספת מפתח |
MGMT-1983 | Get an OAuth 2.0 authorization code API returns wrong status |
MGMT-1962 | שגיאה בכניסה לממשק המשתמש לניהול באמצעות סיסמה חזקה כניסה לממשק המשתמש באמצעות תווים מיוחדים מסוימים, כמו סימן האחוז, לא נכשלת יותר. |
MGMT-1947 | תפקידים לא אינטואיטיביים בממשק המשתמש לניהול אם למשתמש אין הרשאה ליצור או לערוך מדיניות תיעוד עסקאות, לחצני ממשק המשתמש ליצירה ולעריכה של מדיניות תיעוד עסקאות מושבתים עכשיו. |
MGMT-1899 | נתיבי המשאבים נמחקים אחרי שמירת הגדרות המוצר כשעורכים מוצר API, נתיבי המשאבים של המוצר עלולים להימחק אם המשתמש לוחץ לחיצה כפולה על לחצן השמירה. כבר פתרנו את הבעיה הזו. |
MGMT-1894 | הטעינה של דף האפליקציות של המפתחים לעולם לא מסתיימת בעמודה של המפתח |
MGMT-1882 | שרת proxy חדש ל-API מ-WSDL מציג רק את פרטי הפרמטר האחרון |
MGMT-1878 | אם פורסים כמה גרסאות לסביבה, ב-Trace מוצגת רק אחת מהן |
MGMT-1872 | לא ניתן להוריד דוחות בהתאמה אישית |
MGMT-1863 | לא ניתן להציג יומני Node.js בממשק המשתמש לניהול |
MGMT-1843 | שרת ה-proxy ל-API לא נפתח |
MGMT-1833 | למשתמש sysadmin לא צריכה להיות אפשרות לשנות את הסיסמה בממשק המשתמש של OPDK |
MGMT-1825 | באגים של פרצות אבטחה XSS (cross-site scripting) |
MGMT-1824 | שגיאה ב-Fetch WSDL במהלך ייבוא קובץ WSDL עם סיומת .xml |
MGMT-1812 | הוספת אימות של TargetEndpoint במהלך הייבוא בדומה ל-ProxyEndpoint, במהלך הייבוא של שרת ה-proxy ל-API, המערכת תאמת את הסכימה והביטויים המתאימים של TargetEndpoint שנעשה בהם שימוש בתנאים. |
MGMT-1804 | במקרים מסוימים, ה-API של Node.js שולח JSON לא תקין המסך של יומני Node.js מוצגים יומנים לא מעוצבים אם בנתוני ה-JSON יש תווים לא חוקיים. הבעיה תוקנה בגרסה הזו, וממשק המשתמש מציג עכשיו יומני node.js בפורמט תקין. |
MGMT-1802 | password reset url #118 אם ממשק המשתמש לניהול נמצא מאחורי שרת SSL מסוג terminating, עכשיו הוא יוצר כראוי אימייל לאיפוס הסיסמה עם קישור לכתובת URL מסוג https במקום לכתובת URL מסוג http. |
MGMT-1799 | נקודת חולשה באבטחת ממשק המשתמש בשליחת בקשה ב-Trace |
MGMT-1777 | לא ניתן להוסיף משתמש עם כתובת אימייל עם סיומת ברמה העליונה (TLD) של .acn |
MGMT-1735 | מיתוג "שגיאה במהלך אחזור W" החל מהיום, הסרנו את התמיכה במיתוג מותאם אישית ב-Edge OPDK. אנחנו מבינים שהדבר עלול לאכזב את הלקוחות הבודדים שהשתמשו בתכונה הזו, אבל זו לא תכונה שמשפרת באופן ישיר את היכולות של Edge בנושא ניהול ממשקי API. |
MGMT-1569 | בעיה בקישור שרת proxy ל-API למוצר API קיים תוקנה בעיה בקישור שרת proxy ל-API למוצר API בממשק המשתמש לניהול, כששרת ה-proxy ל-API היה עם משאב לנתיב /. |
MGMT-1563 | לחצן השליחה ב-Trace נשאר מושבת אם הוא נתקל בשגיאה |
MGMT-1362 | האימייל 'שכחתי את הסיסמה' לא פועל אם כתובת האימייל מכילה '_' תוקנה בעיה של איפוס סיסמה ב-OPDK עם כתובות אימייל שמכילות קו תחתון. |
MGMT-1345 | ייבוא של WSDL עם כמה מרחבי שמות גורם לשלב שגוי של Build SOAP |
MGMT-1193 | שמירת שרת proxy כגרסה חדשה שמשנה באופן בלתי צפוי את כלל המסלול |
MGMT-1061 | SmartDocs: Description of body type parameter in Swagger definition not shown in doc UI |
MGMT-800 | יצירת משאב בשם 'default' גורמת לתצוגת משתמש שבורה |
MGMT-787 | בעיה בממשק המשתמש של התראות בממשק המשתמש לניהול, כשלוחצים על + API Proxy ומוצגת תיבת הדו-שיח New API Proxy, אפשר ללחוץ על Esc כדי לסגור את תיבת הדו-שיח. |
MGMT-619 | הפעלת חלוקה לדפים בדף של ממשק המשתמש של שרת ה-proxy ל-API |
MGMT-602 | תצוגת הפיתוח של שרת proxy ל-API: הוספת מדיניות של מטמון תגובות כשנקודת קצה לא כוללת תהליך PreFlow/PostFlow שגורם לשגיאה |
MGMT-460 | שינוי השם של המדיניות גורם לבעיות בהתנהגות, למדיניות כפולה שלא ניתן להסיר |
DEVRT-1644 | חיפוש התראות לפי שם גורם לשליחת אימייל שגוי |
DEVRT-1583 | בממשק המשתמש של המונטיזציה מוצג התג 'עתידי' לתוכנית התמחור הנוכחית |
DEVRT-1546 | המגבלות של התוכנית לא פועלות |
DEVRT-1511 | שגיאת mint.resourceDoesNotExist למפתח קיים |
CORERT-639 | ה-TCPSysLogSocket חייב להיות אסינכרוני |
CORERT-613 | כשל בהקשאת לחיצת היד של SSL בגלל 'unrecognized_name' |
AXAPP-1728 | התעלמות ממשתני מונטיזציה ב-Analytics |
AXAPP-1708 | נראה ש-Analytics API מניב מספרים שונים לאותה סטטיסטיקה בהתאם לאופן שבו אני מבקש |
AXAPP-1707 | שיפור הביצועים של ניתוח הנתונים של הפודקאסט בחינם |
AXAPP-1690 | 'שגיאת API לא חוקית' בדוחות מותאמים אישית |
AXAPP-1533 | ב-Analytics Geomap מתקבלת השגיאה 'קריאה לא חוקית ל-API' |
AXAPP-1493 | נתונים סטטיסטיים שגויים לגבי ביצועי המטמון |
APIRT-1436 | יצירת כלי או סקריפט ליצירת גיבוב של אסימונים ללא גיבוב |
APIRT-1425 | למאפיין continueOnError, כשהוא מוגדר כ-true, אין השפעה על המדיניות של JavaCallout |
APIRT-1346 | OAuth2.0 – הערך המגובב מוחזר בתגובה של אסימון הגישה כשהערך של hash.oauth.tokens.enabled הוא true |
APIRT-1206 | השדה target_ip לא מתועד בטבלת העובדות עבור קוד השגיאה 503 ורוב השגיאות מסוג 504 |
APIRT-1170 | קובץ משאב חסר גרם לכך ש-MP לא הצליח לטעון סביבה |
APIRT-1148 | הפעלת GET של המשתנה {message.version} ב-ResponseFlow, עבור יעד Node.js, מפעילה NPE |
APIRT-1054 | כשמנסים לרשום ביומן בספרייה אחרת מלבד ספריית ברירת המחדל, השירות Message Logging נכשל |
APIRT-387 | הפעלת OrganizationService ב-MP בגרסת 'others' |
APIRT-67 | מדיניות OAuth GenerateAccessToken לא מגדירה בצורה נכונה את המשתנה oauthV2.failed |
APIRT-52 | דוחות מותאמים אישית: קוד סטטוס התגובה של הרבה ממשקי API הוא null |
בעיות מוכרות
בגרסה הזו יש את הבעיות הידועות הבאות.
מזהה הבעיה | תיאור |
---|---|
OPDK-1586 |
הפורטל של API BaaS לא מצליח להתחיל אם לא מפעילים תמיכה ב-IPV6
|
OPDK-1785 |
התקנת רכיב המונטיזציה בסביבה מותקנת של Edge משודרג
הפתרון הוא להגדיר את גרסת המונטיזציה הנכונה בקובץ apigee-env.sh לפני שמנסים להתקין את המונטיזציה. כדי לקבל את הגרסה של מונטיזציה ב-4.15.07
(אחרי שכבר שדרגתם ל-Edge 4.15.07), מריצים את הפקודה:
> source /{install-dir}/apigee4/bin/apigee-env.sh > VER=`basename $(find $SHARE_DIR/installer/monetization -name "mint-*.zip") | cut -d "-" -f 2,3,4`
כברירת מחדל, הערך של install-dir הוא /opt.
צריך להגדיר את הערך של VER שלמעלה בקובץ apigee-env.sh:
> sed -i "s/^MONETIZATION_VERSION=.*/MONETIZATION_VERSION=$VER/" /install-dir/apigee4/bin/apigee-env.sh
אם ניסיתם להתקין את התכונה 'מונטיזציה' בלי לבצע את השלבים שלמעלה, ההתקנה נכשלת וסביר להניח שיש קישור ללא יעד בספריית השיתוף. צריך להסיר את הקישור הלא ישיר:
> rm /install-dir/apigee4/share/monetization
אחרי הסרת הקישור הלא ישיר, מבצעים את השלבים שלמעלה כדי להגדיר את גרסת המונטיזציה, ואז מנסים שוב להתקין את המונטיזציה.
|
OPDK-1857 |
גרסת Python 2.6 מקודדת ב-bin/qpid-stat.sh וב-bin/qpid-config.sh ב-CentOS וב-RedHat 7.0, כמה סקריפטים ב-bin/qpid-stat.sh וב-bin/qpid-config.sh מקודדים מראש לשימוש ב-Python בגרסה 2.6. הפתרון לבעיה הזו הוא לשנות את השורה שמייצאת את PYTHONPATH בקובצי qpid-stat.sh ו-qpid-config.sh בתיקייה apigee4/bin.
כדי לבדוק איזו גרסה של Python מותקנת במערכת, בודקים את גרסת Python בתיקייה /opt/apigee4/share/apache-qpid/lib. סביר להניח שהספרייה היא python2.7. לאחר מכן צריך לעדכן את ההגדרה PYTHONPATH בקובצי qpid-stat.sh ו-qpid-config.sh עם הנתיב הנכון. לדוגמה:
|
DEVRT-1574 | יתרה ושימוש לא עקביים למפתחים עם כמה תוכניות תעריף פעילות במסגרת המונטיזציה, אם למפתח יש יותר מתוכנית תעריף אחת עם חיובים לכל קריאה ל-API, לפעמים השימוש ביתרה הכספית עשוי להיות לא עקבי. |
APIBAAS-1647 | לאחר התחברות כאדמין מערכת, בממשק המשתמש של BaaS מופיעה ההודעה 'שגיאה בקבלת התפקידים' הודעת השגיאה הזו מופיעה בהתחברות הראשונה של האדמין למערכת אחרי השדרוג מ-4.15.01 ל-4.15.07. אפשר להתעלם מההודעה הזו. |
DEVRT-1834 |
שדרוג המונטיזציה לגרסה 4.15.07 בסוף התסריט apigee-upgrade.sh תופיע ההודעה הבאה עם בקשה להריץ תסריט נוסף: ************************************** In order to complete the monetization upgrade please run: sudo /opt/apigee4/share/monetization/schema/migration/MOPDK4.15.04.00/ 365-create-notification-condition.sh ************************************** אפשר להתעלם מההודעה הזו. הסקריפט הזה לא נדרש ואי אפשר להריץ אותו. |
DEVRT-1951 |
Monetization fresh installation missing notification configurations
בהתקנה חדשה של Apigee Edge for Private Cloud בגרסה 4.15.07.00, ההגדרות הבאות של התראות מונטיזציה חסרות. הם תואמים לסוגי ההתראות בדף 'אדמין' > 'התראות' בממשק המשתמש לניהול.
mint.scheduler.${ORG_ID}.adhocnotify@@@management
mint.scheduler.${ORG_ID}.expiringrateplannotify@@@management
mint.scheduler.${ORG_ID}.newpkgnotify@@@management
mint.scheduler.${ORG_ID}.newproductnotify@@@management
mint.scheduler.${ORG_ID}.newrateplannotify@@@management
mint.scheduler.${ORG_ID}.tncacceptancenotify@@@management
כדי לעקוף את הבעיה הזו, יש לבצע את השלבים הבאים. תצטרכו את כתובת ה-IP של מכונה של Cassandra. כדי למצוא אותו, מחפשים את הקובץ בנתיב <installation-root>/apigee4/conf/cassandra/cassandra.yaml או בנתיב <installation-root>/apigee4/conf/cassandra/cassandra-topology.properties.
|
DEVRT-1952 |
שדרוג המונטיזציה מגרסה 4.14.07.00: הגדרות התראות חסרות
בשדרוג של Apigee Edge לענן פרטי מגרסה 4.14.07.00 לגרסה 4.15.07.00, ההגדרות הבאות של התראות מונטיזציה חסרות, וכתוצאה מכך דוחות המונטיזציה לא פועלים כראוי.
mint.scheduler.${ORG_ID}.chargedaily@@@management
mint.scheduler.${ORG_ID}.chargehourly@@@management
כדי לעקוף את הבעיה הזו, יש לבצע את השלבים הבאים. תצטרכו את כתובת ה-IP של מכונה של Cassandra. כדי למצוא אותו, מחפשים את הקובץ בנתיב <installation-root>/apigee4/conf/cassandra/cassandra.yaml או בנתיב <installation-root>/apigee4/conf/cassandra/cassandra-topology.properties.
|
OPDK-1878 | לא ניתן להגדיר את שם ה-Pod בהתקנה בכמה מרכזי נתונים במדריך ההתקנה של Edge מצוין להגדיר את שמות ה-Pod בתור gateway-1 ו-gateway-2 בקובצי ההתקנה השקטה להתקנה בכמה מרכזי נתונים. עם זאת, שינוי השם של ה-Pod ימנע את הרישום הראוי של הנתב ומעבד ההודעות, וגם את הגישה אליהם. הבעיה הזו גם מונעת מהסקריפט setup-org.sh למצוא מעבדי הודעות זמינים. הפתרון הוא להגדיר את שם ה-Pod, באמצעות המאפיין MP_POD, ל-gateway בקובץ ההתקנה השקט בשני מרכזי הנתונים. |
OPDK-1886 |
לצומת אין גישה לכתובות IP מקומיות כמו 192.168.x.y connect.ranges.denied=10.0.0.0/8,192.168.0.0/16,127.0.0.1/32 לאחר מכן, מפעילים מחדש את צמתים של מעבד ההודעות: <install_dir>/apigge4/bin/apigee-service message-processor restart |
OPDK-1958 | במהלך השדרוג, לכל הצמתים תהיה צורך בגישה ליציאה 8080 בשרת הניהול במהלך זמן הריצה, לרכיבים הבאים תהיה צורך בגישה ליציאה 8080 בשרת הניהול: Route, Message Processor, UI, Postgres ו-Qpid. עם זאת, במהלך השדרוג, כל הצמתים יצטרכו גישה ליציאה 8080 בשרת הניהול, כולל צמתים של Cassandra ו-Zookeeper. |
OPDK-1962 | צריך להגדיר מחדש את SSL ל-Edge API אחרי השדרוג אם הגדרתם את Edge API לשימוש ב-SSL לפני השדרוג לגרסה 4.15.07.00, תצטרכו להגדיר מחדש את SSL אחרי השדרוג. במדריך לפעולות של Edge מוסבר איך מגדירים SSL ל-Edge API. |