Szablony Zdalnej konfiguracji i obsługa wersji


Remote Config to zbiory parametrów i warunków w formacie JSON utworzone przez Ciebie na potrzeby projektu w Firebase. Możesz tworzyć szablony klienta, z których aplikacja pobiera wartości, oraz szablony serwera, z których klienci serwera mogą pobierać wartości.

Ta sekcja dotyczy szablonów serwera. Aby dowiedzieć się więcej o szablonach dotyczących konkretnych klientów, kliknij Szablony klientów.

Szablon możesz modyfikować i nim zarządzać w konsoli Firebase. Otwórz 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-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
  }
}

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

  • Wyświetlanie listy wszystkich zapisanych wersji szablonu
  • Pobieranie konkretnej wersji
  • Cofanie do konkretnej wersji klienta
  • Usuwanie szablonów Remote Config ze strony Historia zmian.

Łączny limit przechowywanych wersji wynosi 300 na typ szablonu (300 szablonów klienta i 300 szablonów serwera), w tym numery przechowywanych wersji usuniętych szablonów. Jeśli w trakcie projektu opublikujesz więcej niż 300 wersji szablonu danego typu, najstarsze wersje zostaną usunięte, a maksymalna liczba wersji tego typu wyniesie 300.

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

Szablony Remote Config możesz w razie potrzeby usuwać na stronie DevOps i zaangażowanie > Zdalna konfiguracja > Historia zmianw konsoli Firebase.

Zarządzanie wersjami szablonu Remote Config

W tej sekcji opisujemy, jak zarządzać wersjami Remote Configszablonu.

Wyświetlanie listy 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 po prawej stronie znajdziesz menu z listą wszystkich zapisanych wersji szablonu.

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

Pobieranie konkretnej wersji szablonu Remote Config

Możesz pobrać dowolną zapisaną wersję szablonu Remote Config. Aby przywrócić 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 obecnie aktywny szablon. Aby wyświetlić inną wersję, wybierz ją w panelu szczegółów po prawej stronie.

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

Wycofaj zmiany do określonej zapisanej wersji szablonu Remote Config

Możesz wycofać zmiany do dowolnej zapisanej wersji szablonu. Aby wycofać zmiany w szablonie:

  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 poprzednich wersji szablonu, które można przywrócić.

  3. Kliknij i potwierdź tylko wtedy, gdy masz pewność, że chcesz wycofać zmiany do tej wersji i natychmiast używać tych wartości we wszystkich aplikacjach i w przypadku wszystkich użytkowników.

Pamiętaj, że ta operacja wycofania powoduje utworzenie nowej wersji numerowanej. Na przykład przywrócenie wersji 10 do wersji 6 powoduje utworzenie nowej kopii wersji 6, która różni się od oryginału tylko numerem wersji 11. Oryginalna wersja 6 jest nadal przechowywana (o ile nie upłynął jej okres ważności), a wersja 11 staje się aktywnym szablonem.

Usuwanie szablonu Remote Config

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

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

  2. Kliknij Historia zmian.

  3. Przełącz się na szablon, 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 Remote Config szablony, aby zintegrować je z systemami kontroli źródła i kompilacji, zautomatyzować aktualizacje konfiguracji oraz synchronizować parametry i wartości w wielu projektach.

Obecnie aktywny Remote Configszablonz Firebasekonsoli. Następnie możesz zaktualizować wyeksportowany plik JSON i opublikować go w tym samym projekcie lub w nowym bądź istniejącym projekcie.

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

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

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

Aby wyeksportować i zaimportować szablony Remote Config:

  1. Pobierz bieżący Remote Config szablon konfiguracji.
  2. Sprawdź Remote Configszablon.
  3. Opublikuj Remote Configszablon.

Pobieranie bieżącego szablonu Zdalnej konfiguracji

Aby pobrać aktywny szablon Remote Config w formacie JSON, wykonaj te czynności:

  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 konfiguracyjny.

  3. Gdy pojawi się odpowiedni komunikat, kliknij Pobierz plik konfiguracyjny, wybierz miejsce, w którym chcesz zapisać plik, a następnie kliknij Zapisz.

Weryfikowanie szablonu Zdalnej konfiguracji

Szablony serwera są weryfikowane, gdy próbujesz opublikować je z Firebasekonsoli. Pamiętaj, że warunki „Użytkownik w losowym procencie” można importować, ale każdy nieobsługiwany warunek spowoduje błąd podczas przesyłania. Jeśli próbujesz opublikować szablon, który został pierwotnie wyeksportowany z szablonu klienta, najpierw usuń wszystkie warunki specyficzne dla klienta.

Publikowanie szablonu Remote Config

Po pobraniu szablonu, wprowadzeniu niezbędnych zmian w treś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 numeru wersji szablonu o 1. Ponieważ cała konfiguracja jest zastępowana, jeśli usuniesz parametr z pliku JSON i opublikujesz go, 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 wycofać zmiany do poprzedniej wersji.

Aby opublikować szablon, użyj tych poleceń:

  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 pojawi się komunikat, kliknij Przeglądaj, przejdź do pliku Remote Config, który chcesz opublikować, i wybierz go, a potem kliknij Wybierz.

  4. Plik zostanie zweryfikowany. Jeśli weryfikacja zakończy się powodzeniem, możesz kliknąć Opublikuj, aby konfiguracja była od razu dostępna dla Twoich aplikacji i użytkowników.

Dalsze kroki