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


Шаблоны удаленной конфигурации — это наборы параметров и условий в формате 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 из консоли Firebase. Чтобы удалить шаблон Remote Config:

1. На странице «Параметры удаленной конфигурации» нажмите История изменений» .
  1. Переключитесь на шаблон, который хотите удалить, нажмите More , затем выберите «Удалить» .

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

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

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

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

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

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

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

Чтобы экспортировать и импортировать шаблоны Remote Config:

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

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

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

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

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

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

Публикация шаблона удаленной конфигурации

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

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

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

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

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

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