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


Шаблоны 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. Переключитесь на шаблон, который вы хотите удалить, нажмите Еще , затем выберите Удалить .

  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 . Обратите внимание, что условия User in Random Percentage можно импортировать, но любое неподдерживаемое условие вызовет ошибку во время загрузки. Если вы пытаетесь опубликовать шаблон, который изначально был экспортирован из клиентского шаблона, обязательно сначала удалите все клиентские условия.

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

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

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

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

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

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

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