Mengelola template dan pembuatan versi server Remote Config

Pilih jenis template: Template klien Template server


Template Remote Config adalah serangkaian parameter dan kondisi berformat JSON yang dibuat untuk project Firebase Anda. Template server menyajikan konfigurasi ke instance server menggunakan Firebase Admin SDK untuk Remote Config (tersedia untuk Node.js, Java, Python, dan Go).

Anda dapat menggunakan konsol Firebase untuk mengubah dan mengelola template server. Buka DevOps & Engagement > Remote Config untuk melihat konten template dalam format grafis di halaman Parameters dan Conditions.

Berikut adalah contoh file template server:

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

Anda dapat melakukan tugas pengelolaan versi berikut di konsol Firebase (buka DevOps & Engagement > Remote Config):

  • Mencantumkan semua versi template tersimpan
  • Mengambil versi tertentu
  • Melakukan roll back ke versi server tertentu
  • Menghapus template Remote Config dari halaman Change history.

Batas total versi masa aktif yang tersimpan per jenis template adalah 300 (300 template klien dan 300 template server), yang meliputi nomor versi tersimpan untuk template yang dihapus. Jika Anda memublikasikan lebih dari 300 versi template per jenis template selama masa aktif project, versi paling awal akan dihapus, sehingga mempertahankan jumlah maksimum 300 versi untuk jenis tersebut.

Setiap kali Anda mengupdate parameter, Remote Config akan membuat template Remote Config versi baru dan menyimpan template sebelumnya sebagai versi yang dapat Anda ambil atau roll back sesuai kebutuhan. Nomor versi bertambah secara berurutan dari nilai awal yang disimpan oleh Remote Config. Semua template menyertakan kolom version seperti yang ditunjukkan, yang berisi metadata tentang versi spesifik tersebut.

Anda dapat menghapus template Remote Config sesuai kebutuhan di DevOps & Engagement > Remote Config > Change history page di konsol Firebase.

Mengelola versi template Remote Config

Bagian ini menjelaskan cara mengelola versi template server Remote Config.

Mencantumkan semua versi template Remote Config yang tersimpan

Anda dapat mengambil daftar semua versi template Remote Config yang disimpan. Untuk melakukannya:

  1. Di konsol Firebase, buka DevOps & Engagement > Remote Config > Parameters page.

  2. Pilih ikon "jam" yang ditampilkan di kanan atas.

    Tindakan ini akan membuka Change history page yang mencantumkan semua versi template tersimpan di menu daftar di sebelah kanan.

    Daftar template ini mencakup metadata semua versi yang disimpan, termasuk waktu update, pengguna yang melakukannya, dan bagaimana hal tersebut dilakukan.

Mengambil versi template Remote Config tertentu

Anda dapat mengambil versi template Remote Config tertentu yang tersimpan. Berikut cara mengambil versi template tersimpan:

  1. Di konsol Firebase, buka halaman DevOps & Engagement > Remote Config > Change history.

  2. Secara default, halaman menampilkan template aktif saat ini. Untuk melihat versi lain, pilih dari panel detail di sebelah kanan.

  3. Lihat perbedaan terperinci dari template aktif dan versi tersimpan lainnya dengan mengarahkan kursor ke menu konteks untuk setiap versi yang tidak dipilih dan memilih Compare with selected version.

Melakukan roll back ke versi template Remote Config tertentu yang tersimpan

Anda dapat melakukan roll back ke versi template yang tersimpan. Berikut cara me-roll back template:

  1. Di konsol Firebase, buka halaman DevOps & Engagement > Remote Config > Change history.

  2. Cari tombol opsi di kanan atas halaman untuk versi template sebelumnya yang memenuhi syarat untuk rollback.

  3. Klik dan konfirmasi tombol ini hanya jika Anda yakin ingin melakukan roll back ke versi itu dan gunakan nilai tersebut segera untuk semua aplikasi dan pengguna.

Perhatikan bahwa operasi rollback ini secara efektif membuat versi bernomor baru. Misalnya, melakukan roll back dari versi 10 ke versi 6 akan menghasilkan salinan baru untuk versi 6, yang berbeda dari aslinya hanya pada nomor versinya, yaitu 11. Versi 6 yang asli masih disimpan, dengan asumsi bahwa akhir masa berlakunya belum tercapai, yang akan membuat versi 11 menjadi template aktif.

Menghapus template Remote Config

Anda dapat menghapus template Remote Config menggunakan Firebase console. Berikut cara menghapus template:

  1. Di konsol Firebase, buka DevOps & Engagement > Remote Config > Parameters page.

  2. Klik Histori perubahan.

  3. Alihkan ke template yang ingin Anda hapus, klik Lainnya, lalu pilih Hapus.

  4. Saat diminta untuk mengonfirmasi penghapusan, klik Delete.

Mendownload dan memublikasikan template Remote Config

Download dan publikasikan template Remote Config untuk mengintegrasikannya ke dalam kontrol sumber dan sistem build, mengotomatiskan update konfigurasi, serta menjaga parameter dan nilai tetap sinkron di beberapa project.

Anda dapat mendownload template Remote Config yang saat ini aktif dari Firebase console. Selanjutnya, Anda dapat memperbarui file JSON yang diekspor dan memublikasikannya ke project yang sama, atau memublikasikannya ke project baru atau yang sudah ada.

Misalnya, Anda memiliki beberapa project yang mewakili berbagai tahap siklus proses pengembangan software, seperti lingkungan pengembangan, pengujian, staging, dan produksi. Dalam hal ini, Anda dapat mempromosikan template yang telah diuji sepenuhnya dari lingkungan staging ke lingkungan produksi dengan mendownloadnya dari project staging dan memublikasikannya ke project produksi.

Anda juga dapat menggunakan metode ini untuk memigrasikan konfigurasi dari satu project ke project lainnya, atau mengisi project baru dengan parameter dan nilai dari project yang sudah stabil.

Parameter dan parameter value yang dibuat khusus sebagai varian dalam eksperimen A/B Testing tidak disertakan dalam template yang diekspor.

Untuk mengekspor dan mengimpor template Remote Config:

  1. Download template Remote Config saat ini.
  2. Validasi template Remote Config.
  3. Publikasikan template Remote Config.

Mendownload template Remote Config saat ini

Gunakan perintah berikut untuk mendownload template Remote Config yang aktif dalam format JSON:

  1. Di konsol Firebase, buka halaman DevOps & Engagement > Remote Config > Parameters or Conditions.

  2. Buka Menu, lalu pilih Download current config file.

  3. Saat diminta, klik Download config file, pilih lokasi yang diinginkan untuk menyimpan file, lalu klik Save.

Memvalidasi template Remote Config

Template server akan divalidasi saat Anda mencoba memublikasikan konten dari Firebase console. Kondisi yang menggunakan aturan Pengguna dalam persentase acak dapat diimpor, tetapi kondisi yang tidak didukung akan menghasilkan error selama upload. Jika Anda mencoba memublikasikan template yang awalnya diekspor dari template klien, pastikan untuk menghapus kondisi khusus klien terlebih dahulu.

Memublikasikan template Remote Config

Setelah mendownload template, melakukan perubahan yang diperlukan pada konten JSON, dan memvalidasinya, Anda dapat memublikasikannya ke project.

Memublikasikan template berarti mengganti seluruh template konfigurasi yang ada dengan file yang telah diperbarui dan menambahkan versi template satu per satu. Karena seluruh konfigurasi diganti, jika Anda menghapus parameter dari file JSON dan memublikasikannya, parameter akan dihapus dari server dan tidak lagi tersedia untuk klien.

Setelah dipublikasikan, perubahan pada parameter dan nilai akan segera tersedia untuk aplikasi dan pengguna Anda. Jika perlu, Anda dapat melakukan roll back ke versi sebelumnya.

Gunakan langkah-langkah berikut untuk memublikasikan template Anda:

  1. Di konsol Firebase, buka halaman DevOps & Engagement > Remote Config > Parameters or Conditions.

  2. Buka Menu, lalu pilih Publish from a file.

  3. Saat diminta, klik Browse, buka dan pilih file Remote Config yang ingin Anda publikasikan, lalu klik Select.

  4. File divalidasi. Jika validasi berhasil, klik Publikasikan agar konfigurasi bisa langsung tersedia bagi aplikasi dan pengguna Anda.

Langkah berikutnya