Gerenciar modelos e controle de versões da Configuração remota no servidor

Selecione o tipo de modelo: Modelos de cliente Modelos de servidor


Os modelos de Remote Config são conjuntos de parâmetros e condições no formato JSON criados para seu projeto do Firebase. Os modelos de servidor disponibilizam configurações para instâncias de servidor usando o Firebase Admin SDK para Remote Config (disponível para Node.js, Java, Python e Go).

É possível usar o console do Firebase para modificar e gerenciar o modelo de servidor. Acesse DevOps e engajamento > Configuração remota para conferir o conteúdo do modelo em formato gráfico nas páginas Parâmetros e Condições.

Confira um exemplo de arquivo de modelo de servidor:

{
  "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
  }
}

É possível realizar estas tarefas de gerenciamento de versões no console do Firebase (acesse DevOps e engajamento > Configuração remota):

  • Listar todas as versões de modelos armazenadas.
  • Recuperar uma versão específica.
  • Reverter para uma versão específica do servidor
  • Exclua os modelos de Remote Config na página Histórico de alterações.

Há um limite total de 300 versões armazenadas com ciclo de vida por tipo de modelo (300 modelos de cliente e 300 de servidor), o que inclui números de versão armazenados para modelos excluídos. Se você publicar mais de 300 por tipo de modelo durante a vida útil de um projeto, as versões mais antigas são excluídas, mantendo no máximo 300 versões desse tipo.

Sempre que você atualiza os parâmetros, Remote Config cria um modelo de Remote Config com controle de versões e armazena o modelo anterior como uma versão que você pode recuperar ou reverter, conforme necessário. Os números de versão são incrementados de maneira sequencial com base no valor inicial armazenado por Remote Config. Todos os modelos incluem um campo version, conforme mostrado, que contém metadados sobre essa versão específica.

É possível excluir modelos de Remote Config conforme necessário na página DevOps e engajamento > Configuração remota > Histórico de alterações do console do Firebase.

Gerenciar versões do modelo de Remote Config

Esta seção descreve como gerenciar versões do modelo de servidor Remote Config.

Listar todas as versões armazenadas do modelo de Remote Config

É possível recuperar uma lista de todas as versões armazenadas do modelo de Remote Config. Para isso, siga estas etapas:

  1. No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Parâmetros.

  2. Selecione o ícone de relógio exibido no canto superior direito.

    Isso abre a página Histórico de alterações, que lista todas as versões de modelo armazenadas em um menu à direita.

    A lista de modelos inclui metadados para todas as versões armazenadas, incluindo a hora da atualização, o usuário que a fez e como ela foi feita.

Recuperar uma versão específica do modelo de Remote Config

É possível recuperar qualquer versão específica armazenada do modelo de Remote Config. Veja como recuperar uma versão de modelo armazenada:

  1. No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Histórico de alterações.

  2. Por padrão, a página mostra o modelo ativo atual. Para conferir uma versão diferente, selecione-a no painel de detalhes à direita.

  3. Para visualizar uma comparação detalhada entre o modelo ativo e qualquer outra versão armazenada, passe o cursor sobre o menu de contexto de qualquer versão não selecionada e clique em Comparar com a versão selecionada.

Reverter para uma versão específica armazenada do modelo de Remote Config

É possível reverter para qualquer versão armazenada do modelo. Veja como reverter um modelo:

  1. No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Histórico de alterações.

  2. Localize o botão de opção no canto superior direito da página para versões de modelo anteriores qualificadas para reversão.

  3. Clique e confirme essa opção apenas se tiver certeza de que você quer reverter para essa versão e usar esses valores imediatamente para todos os apps e usuários.

Na realidade, essa operação de reversão cria uma nova versão numerada. Por exemplo, a reversão da versão 10 para a versão 6 cria uma nova cópia da versão 6, que é diferente da original apenas porque o número de versão é 11. A versão 6 original ainda é armazenada, caso não tenha atingido a expiração, e a versão 11 se torna o modelo ativo.

Excluir um modelo de Remote Config

É possível excluir modelos de Remote Config usando o console Firebase. Veja como excluir um modelo:

  1. No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Parâmetros.

  2. Clique em Histórico de alterações.

  3. Alterne para o modelo que você quer excluir, clique em Mais e selecione Excluir.

  4. Clique em Excluir para confirmar a exclusão.

Fazer o download e publicar modelos de Remote Config

Faça o download e publique modelos de Remote Config para integrá-los aos sistemas de build e controle de origem, automatizar atualizações de configuração e manter os parâmetros e valores sincronizados em vários projetos.

É possível fazer o download do modelo de Remote Config ativo no momento no console de Firebase. É possível atualizar o arquivo JSON exportado e publicá-lo no mesmo projeto ou em um projeto novo ou existente.

Por exemplo, suponha que você tenha vários projetos que representem diferentes estágios do ciclo de vida de desenvolvimento de software, como ambientes de desenvolvimento, teste, preparo e produção. Nesse caso, é possível promover um modelo totalmente testado do seu ambiente de preparo para seu ambiente de produção, fazendo o download dele no projeto de preparo e a publicação no projeto de produção.

Também é possível usar esse método para migrar configurações de um projeto para outro ou preencher automaticamente um novo projeto com parâmetros e valores de um projeto estabelecido.

Os parâmetros e os valores de parâmetro criados especificamente como variantes em um experimento de A/B Testing não estão incluídos nos modelos exportados.

Para exportar e importar modelos de Remote Config:

  1. Faça o download do modelo de Remote Config atual.
  2. Valide o modelo de Remote Config.
  3. Publique o modelo de Remote Config.

Baixar o modelo atual do Remote Config

Use o seguinte para fazer o download do modelo de Remote Config ativo no formato JSON:

  1. No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Parâmetros ou condições.

  2. Abra o Menu e selecione Fazer o download do arquivo de configuração atual.

  3. Quando solicitado, clique em Fazer o download do arquivo de configuração, escolha o local onde você quer salvar o arquivo e clique em Salvar.

Validar o modelo Remote Config

Os modelos de servidor são validados quando você tenta publicá-los pelo console de Firebase. As condições que usam a regra Usuário em porcentagem aleatória podem ser importadas, mas as condições incompatíveis geram um erro durante o upload. Se você estiver tentando publicar um modelo que foi originalmente exportado de um modelo de cliente, primeiro remova as condições específicas do cliente.

Publicar o modelo de Remote Config

Depois de fazer o download de um modelo, fazer as alterações necessárias no conteúdo JSON e validá-lo, é possível publicar o modelo em um projeto.

A publicação substitui todo o modelo da configuração atual pelo arquivo atualizado e incrementa a versão do modelo em um. Como toda a configuração é substituída, se você excluir um parâmetro do arquivo JSON e publicá-lo, o parâmetro é deletado do servidor e fica indisponível para os clientes.

Após a publicação, as alterações nos parâmetros e valores são disponibilizadas imediatamente para os apps e usuários. Se necessário, reverta para a versão anterior.

Siga estas etapas para publicar o modelo:

  1. No console do Firebase, acesse a página DevOps e engajamento > Configuração remota > Parâmetros ou condições.

  2. Abra o Menu e selecione Publicar de um arquivo.

  3. Quando solicitado, clique em Procurar, navegue até o arquivo de Remote Config que você quer publicar e clique em Selecionar.

  4. O arquivo é validado. Se a validação for bem-sucedida, clique em Publicar para disponibilizar a configuração imediatamente para seus apps e usuários.

Próximas etapas