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


Шаблоны 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 . Обратите внимание, что условия «Пользователь в случайном процентном соотношении» можно импортировать, но любое неподдерживаемое условие приведёт к ошибке при загрузке. Если вы пытаетесь опубликовать шаблон, изначально экспортированный из клиентского шаблона, обязательно сначала удалите все клиентские условия.

Опубликовать шаблон Remote Config

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

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

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

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

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

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