תבניות הגדרת תצורה מרחוק וניהול גרסאות


תבניות Remote Config הן קבוצות של תנאים ופרמטרים בפורמט JSON שיצרתם לפרויקט Firebase. אפשר ליצור תבניות לקוח, שמהן האפליקציה מאחזרת ערכים, ותבניות שרת, שמהן לקוחות השרת יכולים לאחזר ערכים.

בסעיף הזה נסביר על תבניות שרתים. למידע נוסף על תבניות ספציפיות ללקוח, לוחצים על תבניות ללקוח.

אפשר לשנות ולנהל את התבנית באמצעות מסוף Firebase, שבו תוכן התבנית מוצג בפורמט גרפי בכרטיסיות Parameters ו-Conditions.

דוגמה לקובץ תבנית של שרת:

{
  "parameters": {
    "preamble_prompt": {
      "defaultValue": {
        "value": "You are a helpful assistant who knows everything there is to know about Firebase! "
      },
      "description": "Add this prompt to the user's prompt",
      "valueType": "STRING"
    },
    "model_name": {
      "defaultValue": {
        "value": "gemini-pro-test"
      },
      "valueType": "STRING"
    },
    "generation_config": {
      "defaultValue": {
        "value": "{\"temperature\": 0.9, \"maxOutputTokens\": 2048, \"topP\": 0.9, \"topK\": 20}"
      },
      "valueType": "JSON"
    },
  },
  "version": {
    "versionNumber": "19",
    "isLegacy": true
  }
}

אפשר לבצע את המשימות הבאות לניהול גרסאות באמצעות מסוף Firebase:

  • הצגת רשימה של כל גרסאות התבניות השמורות
  • אחזור של גרסה ספציפית
  • חזרה לגרסת לקוח ספציפית
  • מחיקת תבניות Remote Config מהדף Change history

המגבלה הכוללת היא 300 גרסאות שמאוחסנות לכל החיים לכל סוג של תבנית (300 תבניות לקוח ו-300 תבניות שרת), כולל מספרי גרסאות שמאוחסנים של תבניות שנמחקו. אם מפרסמים יותר מ-300 גרסאות של תבניות לכל סוג תבנית במהלך החיים של הפרויקט, הגרסאות המוקדמות ביותר נמחקות, כך שיישארו לכל היותר 300 גרסאות מהסוג הזה.

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

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

ניהול גרסאות של תבניות Remote Config

בקטע הזה מוסבר איך לנהל גרסאות של התבנית Remote Config.

הצגת רשימה של כל הגרסאות השמורות של התבנית Remote Config

אפשר לאחזר רשימה של כל הגרסאות השמורות של התבנית Remote Config. ככה עושים את זה:

  1. במסוף Firebase, פותחים את Remote Config.

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

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

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

אחזור של גרסה ספציפית של התבנית Remote Config

אפשר לאחזר כל גרסה ספציפית של התבנית Remote Config ששמורה. כדי לאחזר גרסה של תבנית ששמורה:

  1. פותחים את חלונית הפרטים של היסטוריית השינויים.

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

  3. כדי להציג השוואה מפורטת בין התבנית הפעילה לבין כל גרסה אחרת ששמורה, מעבירים את העכבר מעל תפריט ההקשר של גרסה שלא נבחרה ובוחרים באפשרות Compare with selected version.

חזרה לגרסה ספציפית ששמורה של התבנית Remote Config

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

  1. מאתרים את לחצן האפשרויות בפינה השמאלית העליונה של הדף Change history. לוחצים ומאשרים את הפעולה הזו רק אם אתם בטוחים שאתם רוצים לחזור לגרסה הזו ולהשתמש בערכים האלה מיד בכל האפליקציות והמשתמשים.

חשוב לזכור שפעולת החזרה לאחור יוצרת למעשה גרסה חדשה וממוספרת. לדוגמה, אם חוזרים לגרסה 6 מגרסה 10, נוצרת למעשה עותק חדש של גרסה 6, ששונה מהגרסה המקורית רק במספר הגרסה שהוא 11. גרסת המקור 6 עדיין מאוחסנת, בהנחה שהתוקף שלה לא פג, וגרסה 11 הופכת לתבנית הפעילה.

מחיקת תבנית של Remote Config

אפשר למחוק תבניות Remote Config במסוף Firebase. כדי למחוק תבנית Remote Config:

1. בדף Remote Config Parameters, לוחצים על Change history.
  1. עוברים לתבנית שרוצים למחוק, לוחצים על More ובוחרים באפשרות Delete.

  2. כשמוצגת בקשה לאשר את המחיקה, לוחצים על מחיקה.

הורדה ופרסום של תבניות Remote Config

מורידים ומפרסמים תבניות Remote Config כדי לשלב אותן במערכות לבקרת מקורות ובמערכות build, להפוך את עדכוני התצורה לאוטומטיים ולשמור על סנכרון של פרמטרים וערכים בין כמה פרויקטים.

אפשר להוריד את התבנית Remote Config הפעילהמהמסוף Firebase. לאחר מכן תוכלו לעדכן את קובץ ה-JSON שיוצאו ולפרסם אותו באותו פרויקט, או לפרסם אותו בפרויקט חדש או קיים.

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

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

פרמטרים וערכים של פרמטרים שנוצרו במיוחד כוריאנטים בניסוי A/B Testing לא נכללים בתבניות שיוצאו.

כדי לייצא ולייבא תבניות Remote Config:

  1. מורידים את תבנית התצורה העדכנית של Remote Config.
  2. מאמתים את התבנית Remote Config.
  3. מפרסמים את התבנית Remote Config.

הורדת התבנית הנוכחית של Remote Config

כדי להוריד את התבנית הפעילה של Remote Config בפורמט JSON:

  1. בכרטיסייה Remote Config Parameters or Conditions, פותחים את Menu ובוחרים באפשרות Download current config file.
  2. כשמופיעה בקשה, לוחצים על Download config file, בוחרים את המיקום שבו רוצים לשמור את הקובץ ולוחצים על Save.

אימות התבנית של Remote Config

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

פרסום התבנית Remote Config

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

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

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

כדי לפרסם את התבנית, משתמשים בפקודות הבאות:

  1. בכרטיסייה Remote Config Parameters or Conditions, פותחים את Menu ובוחרים באפשרות Publish from a file.
  2. כשמופיעה בקשה לכך, לוחצים על Browse, עוברים לקובץ Remote Config שרוצים לפרסם ובוחרים אותו. לאחר מכן לוחצים על Select.
  3. הקובץ יאומת, ואם התהליך יסתיים בהצלחה, תוכלו ללחוץ על פרסום כדי שההגדרות יהיו זמינות באופן מיידי לאפליקציות ולמשתמשים שלכם.

השלבים הבאים