Шаблоны удаленной конфигурации и управление версиями


Шаблоны Remote Config — это наборы параметров и условий в формате JSON, которые вы создали для своего проекта Firebase. Вы можете создавать клиентские шаблоны, из которых ваше приложение получает значения, и серверные шаблоны, из которых серверные клиенты могут получать значения.

В этом разделе рассматриваются шаблоны серверов. Чтобы узнать о шаблонах, специфичных для клиента, нажмите «Шаблоны клиента» .

Вы можете изменять и управлять шаблоном с помощью консоли Firebase , которая отображает содержимое шаблона в графическом формате.Вкладки «Параметры» и «Условия» .

Вот пример файла шаблона сервера:

{
  "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 со страницы истории изменений .

Существует ограничение в 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. Затем на вкладке «Параметры » выберите значок «часы», расположенный в правом верхнем углу.

    Это откроет страницу истории изменений , на которой в правом меню в виде списка будут перечислены все сохраненные версии шаблона.

    Список шаблонов содержит метаданные для всех сохраненных версий, включая время обновления, пользователя, который его внес, и способ его выполнения.

Получить конкретную версию шаблона Remote Config

Вы можете получить доступ к любой конкретной сохраненной версии шаблона Remote Config . Чтобы получить доступ к сохраненной версии шаблона:

  1. Откройте панель с подробной информацией в разделе «История изменений» .

  2. Чтобы просмотреть подробную информацию о другой версии в списке, выберите ее в правом меню.

  3. Для просмотра подробного сравнения активного шаблона и любой другой сохраненной версии наведите курсор на контекстное меню любой невыбранной версии и выберите пункт «Сравнить с выбранной версией».

Откат к определенной сохраненной версии шаблона Remote Config

Вы можете вернуться к любой сохраненной версии шаблона. Чтобы откатить шаблон:

  1. Найдите кнопку с параметрами в правом верхнем углу страницы «История изменений» . Нажмите и подтвердите выбор только в том случае, если вы уверены, что хотите вернуться к предыдущей версии и немедленно использовать эти значения для всех приложений и пользователей.

Обратите внимание, что эта операция отката фактически создает новую версию с номером. Например, откат с версии 10 до версии 6 фактически создает новую копию версии 6, отличающуюся от оригинала только тем, что ее номер версии равен 11. Оригинальная версия 6 по-прежнему сохраняется, если срок ее действия еще не истек, а версия 11 становится активным шаблоном.

Удалить шаблон Remote Config

Удалить шаблоны Remote Config можно из консоли Firebase . Чтобы удалить шаблон Remote Config :

1. На странице «Параметры Remote Config нажмите > «Изменить историю» .

  1. Перейдите к шаблону, который хотите удалить, нажмите More , затем выберите Delete .

  2. Когда появится запрос на подтверждение удаления, нажмите «Удалить» .

Загрузите и опубликуйте шаблоны Remote Config .

Загрузите и опубликуйте шаблоны Remote Config , чтобы интегрировать их в ваши системы контроля версий и сборки, автоматизировать обновления конфигурации и синхронизировать параметры и значения в нескольких проектах.

Вы можете скачать текущий активный шаблон Remote Configиз консоли Firebase .Затем вы можете обновить экспортированный JSON-файл и опубликовать его в том же проекте, или опубликовать его в новом или существующем проекте.

Допустим, у вас есть несколько проектов, представляющих разные этапы жизненного цикла разработки программного обеспечения, такие как среда разработки, тестирования, промежуточная и производственная среды. В этом случае вы можете перенести полностью протестированный шаблон из промежуточной среды в производственную, загрузив его из промежуточного проекта и опубликовав в производственном проекте.

Этот метод также можно использовать для переноса конфигураций из одного проекта в другой или для заполнения нового проекта параметрами и значениями из существующего проекта.

Параметры и значения параметров, созданные специально в качестве вариантов в эксперименте A/B Testing не включаются в экспортируемые шаблоны.

Для экспорта и импорта шаблонов Remote Config :

  1. Загрузите текущий шаблон конфигурации Remote Config .
  2. Проверьте шаблон Remote Config .
  3. Опубликуйте шаблон Remote Config .

Загрузите текущий шаблон удаленной конфигурации.

Для загрузки активного шаблона Remote Config в формате JSON используйте следующую команду:

  1. На вкладке «Параметры или условия Remote Config » откройте меню и выберите «Загрузить текущий файл конфигурации» .
  2. При появлении запроса нажмите «Скачать файл конфигурации» , выберите место, куда хотите сохранить файл, а затем нажмите «Сохранить» .

Проверьте шаблон удаленной конфигурации.

При попытке публикации из консоли Firebase серверные шаблоны проверяются. Обратите внимание, что условия типа «Пользователь в случайном процентном соотношении» можно импортировать, но любое неподдерживаемое условие вызовет ошибку при загрузке. Если вы пытаетесь опубликовать шаблон, который изначально был экспортирован из клиентского шаблона, обязательно сначала удалите все условия, специфичные для клиента.

Опубликуйте шаблон Remote Config .

После загрузки шаблона, внесения необходимых изменений в JSON-содержимое и его проверки, вы можете опубликовать его в проекте.

Публикация шаблона заменяет весь существующий шаблон конфигурации обновленным файлом и увеличивает номер версии шаблона на единицу. Поскольку заменяется вся конфигурация, если вы удалите параметр из JSON-файла и опубликуете его, этот параметр будет удален с сервера и больше не будет доступен клиентам.

После публикации изменения параметров и значений немедленно становятся доступны вашим приложениям и пользователям. При необходимости вы можете откатиться к предыдущей версии .

Для публикации шаблона используйте следующие команды:

  1. На вкладке «Параметры или условия Remote Config » откройте меню и выберите «Опубликовать из файла» .
  2. При появлении запроса нажмите «Обзор» , найдите и выберите файл Remote Config который хотите опубликовать, затем нажмите «Выбрать» .
  3. Файл будет проверен, и в случае успеха вы сможете нажать кнопку «Опубликовать» , чтобы немедленно сделать конфигурацию доступной для ваших приложений и пользователей.

Следующие шаги