Zarządzanie szablonami serwera Zdalnej konfiguracji i obsługą wersji

Wybierz typ szablonu: Szablony klienta Szablony serwera


Szablony Remote Config to zestawy parametrów i warunków w formacie JSON utworzone na potrzeby projektu w Firebase. Szablony serwerów udostępniają konfiguracje instancjom serwerów za pomocą Firebase Admin SDK dla Remote Config (dostępnego w przypadku Node.js, Javy, Pythona i Go).

Możesz używać konsoli Firebase, aby modyfikować szablon serwera i nim zarządzać. Kliknij DevOps i zaangażowanie > Zdalna konfiguracja, aby wyświetlić zawartość szablonu w formacie graficznym na stronach Parametry i Warunki.

Oto przykład pliku szablonu serwera:

{
  "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-3.8-flash"
      },
      "valueType": "STRING"
    },
    "generation_config": {
      "defaultValue": {
        "value": "{\"maxOutputTokens\": 2048}"
      },
      "valueType": "JSON"
    }
  },
  "version": {
    "versionNumber": "19",
    "isLegacy": true
  }
}

Te zadania związane z zarządzaniem wersjami możesz wykonywać w konsoli Firebase (kliknij DevOps i zaangażowanie > Zdalna konfiguracja):

  • Wyświetlanie listy wszystkich zapisanych wersji szablonów
  • Pobieranie konkretnej wersji
  • Przywracanie określonej wersji serwera
  • Usuń Remote Config szablony na stronie Historia zmian.

Obowiązuje łączny limit 300 zapisanych wersji na typ szablonu (300 szablonów klienta i 300 szablonów serwera), który obejmuje numery zapisanych wersji usuniętych szablonów. Jeśli w trakcie cyklu życia projektu opublikujesz więcej niż 300 wersji szablonu danego typu, najstarsze wersje zostaną usunięte, aby zachować maksymalnie 300 wersji tego typu.

Za każdym razem, gdy aktualizujesz parametry, Remote Config tworzy nowy szablon Remote Config z numerem wersji i zapisuje poprzedni szablon jako wersję, którą możesz pobrać lub przywrócić w razie potrzeby. Numery wersji są zwiększane sekwencyjnie od wartości początkowej przechowywanej przez Remote Config. Wszystkie szablony zawierają pole version, jak pokazano na ilustracji, które zawiera metadane dotyczące danej wersji.

W razie potrzeby możesz usunąć szablony Remote Config na stronie DevOps i zaangażowanie > Zdalna konfiguracja > Historia zmian w konsoli Firebase.

Zarządzanie wersjami szablonu Remote Config

W tej sekcji opisano, jak zarządzać wersjami szablonu serwera Remote Config.

Wyświetl listę wszystkich zapisanych wersji szablonu Remote Config

Możesz pobrać listę wszystkich zapisanych wersji szablonu Remote Config. Aby to zrobić:

  1. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Parametry.

  2. Wybierz ikonę zegara w prawym górnym rogu.

    Otworzy się strona Historia zmian, na której w menu po prawej stronie znajdziesz wszystkie zapisane wersje szablonu.

    Lista szablonów zawiera metadane wszystkich zapisanych wersji, w tym czas aktualizacji, użytkownika, który ją wprowadził, oraz sposób jej wprowadzenia.

Pobieranie konkretnej wersji szablonu Remote Config

Możesz pobrać dowolną zapisaną wersję szablonu Remote Config. Aby pobrać zapisaną wersję szablonu:

  1. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Historia zmian.

  2. Domyślnie na stronie wyświetlany jest bieżący aktywny szablon. Aby wyświetlić inną wersję, wybierz ją w okienku szczegółów po prawej stronie.

  3. Aby wyświetlić szczegółowe porównanie aktywnego szablonu z dowolną inną zapisaną wersją, najedź kursorem na menu kontekstowe dowolnej niewybranej wersji i wybierz Porównaj z wybraną wersją.

Przywracanie określonej zapisanej wersji szablonu Remote Config

Możesz przywrócić dowolną zapisaną wersję szablonu. Aby przywrócić szablon:

  1. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Historia zmian.

  2. W prawym górnym rogu strony znajdź przycisk opcji dotyczący poprzednich wersji szablonu, które można przywrócić.

  3. Kliknij i potwierdź tę opcję tylko wtedy, gdy masz pewność, że chcesz przywrócić tę wersję i natychmiast użyć tych wartości we wszystkich aplikacjach i dla wszystkich użytkowników.

Pamiętaj, że ta operacja przywracania powoduje utworzenie nowej wersji numerowanej. Na przykład przywrócenie wersji 6 z wersji 10 powoduje utworzenie nowej kopii wersji 6, która różni się od oryginału tylko tym, że jej numer wersji to 11. Oryginalna wersja 6 jest nadal przechowywana, o ile nie wygasła, a wersja 11 staje się aktywnym szablonem.

Usuwanie szablonu Remote Config

Szablony Remote Config możesz usunąć za pomocą konsoli Firebase. Aby usunąć szablon:

  1. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Parametry.

  2. Kliknij Historia zmian.

  3. Przejdź do szablonu, który chcesz usunąć, kliknij Więcej, a następnie wybierz Usuń.

  4. Gdy pojawi się prośba o potwierdzenie usunięcia, kliknij Usuń.

Pobieranie i publikowanie szablonów Remote Config

Pobierz i opublikuj szablony Remote Config, aby zintegrować je z systemami kontroli źródła i kompilacji, zautomatyzować aktualizacje konfiguracji oraz synchronizować parametry i wartości w wielu projektach.

Możesz pobrać obecnie aktywny szablon Remote Config z konsoli Firebase. Możesz wtedy zaktualizować wyeksportowany plik JSON i opublikować go w tym samym projekcie lub w nowym albo istniejącym projekcie.

Załóżmy na przykład, że masz kilka projektów, które reprezentują różne etapy cyklu życia oprogramowania, takie jak środowiska programistyczne, testowe, przejściowe i środowiska produkcyjne. W takim przypadku możesz przenieść w pełni przetestowany szablon ze środowiska przejściowego do środowiska produkcyjnego, pobierając go z projektu przejściowego i publikując w projekcie produkcyjnym.

Możesz też użyć tej metody, aby przenieść konfiguracje z jednego projektu do innego lub wypełnić nowy projekt parametrami i wartościami z utworzonego projektu.

Parametry i wartości parametrów utworzone specjalnie jako warianty w eksperymencie A/B Testing nie są uwzględniane w wyeksportowanych szablonach.

Aby wyeksportować i zaimportować szablony Remote Config:

  1. Pobierz bieżący szablon Remote Config.
  2. Sprawdź poprawność szablonu Remote Config.
  3. Opublikuj szablon Remote Config.

Pobierz bieżący szablon Remote Config

Aby pobrać aktywny szablon Remote Config w formacie JSON, użyj tego polecenia:

  1. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Parametry lub Warunki.

  2. Otwórz Menu i wybierz Pobierz bieżący plik konfiguracji.

  3. Gdy pojawi się prośba, kliknij Pobierz plik konfiguracji, wybierz lokalizację, w której chcesz zapisać plik, a następnie kliknij Zapisz.

Sprawdzanie poprawności szablonu Remote Config

Szablony serwera są sprawdzane, gdy próbujesz opublikować je z konsoli Firebase. Warunki, które używają reguły Użytkownik w losowym odsetku, można importować, ale każdy nieobsługiwany warunek generuje błąd podczas przesyłania. Jeśli próbujesz opublikować szablon, który został pierwotnie wyeksportowany z szablonu klienta, najpierw usuń wszystkie warunki dotyczące klienta.

Publikowanie szablonu Remote Config

Po pobraniu szablonu, wprowadzeniu niezbędnych zmian w zawartości JSON i zweryfikowaniu go możesz opublikować go w projekcie.

Opublikowanie szablonu powoduje zastąpienie całego istniejącego szablonu konfiguracji zaktualizowanym plikiem i zwiększenie wersji szablonu o 1. Ponieważ zastępowana jest cała konfiguracja, jeśli usuniesz parametr z pliku JSON i go opublikujesz, parametr zostanie usunięty z serwera i nie będzie już dostępny dla klientów.

Po opublikowaniu zmiany parametrów i wartości są natychmiast dostępne dla aplikacji i użytkowników. W razie potrzeby możesz przywrócić poprzednią wersję.

Aby opublikować szablon:

  1. W konsoli Firebase otwórz stronę DevOps i zaangażowanie > Zdalna konfiguracja > Parametry lub Warunki.

  2. Otwórz Menu i wybierz Opublikuj z pliku.

  3. Gdy zobaczysz komunikat, kliknij Przeglądaj, znajdź i wybierz plik Remote Config, który chcesz opublikować, a następnie kliknij Wybierz.

  4. Plik został zweryfikowany. Jeśli weryfikacja zakończy się powodzeniem, kliknij Opublikuj, aby natychmiast udostępnić konfigurację aplikacjom i użytkownikom.

Dalsze kroki