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


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

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

אפשר להשתמש במסוף Firebase כדי לשנות את התבנית ולנהל אותה. עוברים אל DevOps & Engagement (פיתוח אפליקציות ואינטראקציה עם משתמשים) > Remote Config (הגדרת תצורה מרחוק) כדי לראות את תוכן התבנית בפורמט גרפי בדף 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 (עוברים אל DevOps & Engagement > הגדרת תצורה מרחוק):

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

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

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

אפשר למחוק תבניות Remote Config לפי הצורך בדף היסטוריית השינויים בקטע DevOps & Engagement > הגדרת תצורה מרחוק > היסטוריית השינויים במסוף Firebase.

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

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

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

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

  1. במסוף Firebase, עוברים אל DevOps & Engagement (פיתוח אפליקציות ואינטראקציה עם משתמשים) > הגדרת תצורה מרחוק > הדף Parameters (פרמטרים).

  2. לוחצים על סמל השעון בפינה השמאלית העליונה.

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

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

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

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

  1. במסוף Firebase, עוברים אל DevOps & Engagement > הגדרת תצורה מרחוק > הדף היסטוריית שינויים.

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

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

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

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

  1. במסוף Firebase, עוברים אל DevOps & Engagement > הגדרת תצורה מרחוק > הדף היסטוריית שינויים.

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

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

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

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

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

  1. במסוף Firebase, עוברים אל DevOps & Engagement (פיתוח אפליקציות ואינטראקציה עם משתמשים) > הגדרת תצורה מרחוק > הדף Parameters (פרמטרים).

  2. לוחצים על היסטוריית שינויים.

  3. מעבירים את המתג לתבנית שרוצים למחוק, לוחצים על סמל האפשרויות הנוספות ובוחרים באפשרות מחיקה.

  4. כשמופיעה בקשה לאישור המחיקה, לוחצים על מחיקה.

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

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

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

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

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

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

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

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

הורדת התבנית הנוכחית של הגדרת התצורה מרחוק

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

  1. במסוף Firebase, עוברים אל DevOps & Engagement (פיתוח אפליקציות ואינטראקציה עם משתמשים) > Remote Config (הגדרת תצורה מרחוק) > הדף Parameters or Conditions (פרמטרים או תנאים).

  2. פותחים את התפריט ובוחרים באפשרות הורדת קובץ ההגדרות הנוכחי.

  3. כשמופיעה בקשה, לוחצים על Download config file, בוחרים את המיקום שבו רוצים לשמור את הקובץ ולוחצים על Save.

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

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

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

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

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

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

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

  1. במסוף Firebase, עוברים אל DevOps & Engagement (פיתוח אפליקציות ואינטראקציה עם משתמשים) > Remote Config (הגדרת תצורה מרחוק) > הדף Parameters or Conditions (פרמטרים או תנאים).

  2. פותחים את התפריט ובוחרים באפשרות פרסום מקובץ.

  3. כשמופיעה בקשה לכך, לוחצים על Browse, עוברים אל קובץ Remote Config שרוצים לפרסם ובוחרים אותו, ואז לוחצים על Select.

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

השלבים הבאים