Microservices Engine:Konfigurasikan rilis bertahap

Buat konfigurasi canary berbasis IP

1. Login ke Konsol MSE dan pilih wilayah di bilah navigasi atas.

2. Di panel navigasi kiri, pilih Microservices Registry > Instances.

3. Pada halaman Instances, klik nama instans target.

4. Di panel navigasi kiri, pilih Configuration Management > Configurations.

5. Temukan konfigurasi target dan klik Edit di kolom Actions.

6. Pada panel Edit Configuration, atur Release Type menjadi IP-based Canary Release.

   

7. Klik kotak input Application Node IP dan pilih alamat IP untuk rilis canary. Anda juga dapat mengetik alamat IP secara manual. Input ini mendukung pengisian otomatis.

   Catatan

   Alamat IP yang tercantum di sini adalah IP dari node yang berlangganan konfigurasi ini. Pisahkan beberapa alamat IP dengan koma (,).

8. Edit konten konfigurasi, lalu klik Canary Release.

9. Pada kotak dialog Comparison of Configuration Content, verifikasi Current Official Version dan Content To Be Released, lalu klik Release.

Lihat konfigurasi canary

1. Buka halaman Configurations dari instans target (langkah 1–4 di atas).

2. Temukan konfigurasi dengan rilis canary aktif dan klik Edit di kolom Actions.

3. Pada panel Edit Configuration, klik tab Beta(IP) untuk melihat detail rilis canary.

   

Hentikan atau promosikan rilis canary

Pada tab Beta(IP) di panel Edit Configuration:

• Hentikan rilis canary: Klik Stop Canary Release. Konfigurasi canary dibuang dan semua node tetap menggunakan versi resmi.

• Promosikan ke rilis penuh: Klik Full Release. Pada kotak dialog Comparison of Configuration Content, konfirmasi konfigurasi dan klik Full Release. Konfigurasi canary menjadi versi resmi baru dan rilis canary berakhir.

Langkah 1: Atur tag aplikasi pada client

Tetapkan tag ke node aplikasi dalam format pasangan kunci-nilai. Anda dapat mengatur tag melalui properties, parameter JVM, atau variabel lingkungan. Jika kunci yang sama didefinisikan di beberapa tempat, urutan prioritasnya adalah: properties > parameter JVM > variabel lingkungan.

nacos.config.gray.label adalah kunci tag bawaan untuk rilis canary.

// Opsi 1: Atur melalui properties
Properties properties = new Properties();
properties.put(PropertyKeyConst.SERVER_ADDR, "<your-nacos-endpoint>");
properties.put("project.name", "<your-app-name>");
properties.put("nacos.config.gray.label", "<your-canary-tag>");

// Opsi 2: Atur sebagai parameter JVM
// -Dnacos.config.gray.label=<your-canary-tag>

// Opsi 3: Atur sebagai variabel lingkungan
// nacos_config_gray_label=<your-canary-tag>

// Buat layanan konfigurasi dan berlangganan konfigurasi
NacosConfigService configService = new NacosConfigService(properties);

String dataId = "<your-data-id>";
String group = "<your-group>";

configService.addListener(dataId, group, new Listener() {
    @Override
    public Executor getExecutor() {
        return null;
    }

    @Override
    public void receiveConfigInfo(String configInfo) {
        System.out.println("Received config: " + configInfo);
    }
});

Ganti placeholder berikut dengan nilai aktual:

Langkah 2: Verifikasi tag pendengar di server

Setelah client terhubung dengan tag, verifikasi bahwa server mengenalinya. Buka daftar pendengar untuk konfigurasi target. Setiap pendengar menampilkan tag yang terkait dengannya.

Langkah 3: Rilis konfigurasi canary berbasis tag

1. Klik Edit Configuration dan atur Release Type menjadi Tag-based Canary Release.

2. Pilih pasangan tag kunci-nilai yang sudah ada. Konsol menampilkan jumlah node yang sesuai dengan tag yang dipilih.

   

3. Edit konten konfigurasi dan klik Canary Release.

Langkah 4: Verifikasi dan perluas rilis

Setelah merilis versi canary:

1. Verifikasi grup canary: Pada tab Listener Query, periksa versi konfigurasi yang diterima setiap node.

2. Lihat detail canary: Pada tab Configuration Details, tinjau konten versi canary saat ini.

3. Perluas cakupan rilis: Setelah memastikan grup canary berjalan normal, perluas nilai tag untuk mencakup lebih banyak node. Ulangi hingga semua node target tercakup.

4. Promosikan ke rilis penuh: Klik Full Release untuk menjadikan konfigurasi canary sebagai versi resmi baru. Versi canary akan dihentikan secara otomatis.

5. Kembalikan jika diperlukan: Jika terjadi masalah, klik Stop Canary Release untuk membuang konfigurasi canary. Semua node kembali ke versi resmi.

Prioritas pencocokan versi

Saat sebuah node meminta konfigurasi, MSE Nacos mengevaluasi versi dalam urutan berikut:

1. Versi canary berbasis IP — Jika IP node sesuai dengan daftar IP canary, versi ini dikembalikan.

2. Versi canary berbasis tag — Jika tidak ada kecocokan IP, sistem memeriksa versi canary berbasis tag yang diurutkan berdasarkan bidang priority (nilai lebih tinggi = prioritas lebih tinggi). Jika nilai prioritas sama, versi diurutkan berdasarkan nama.

3. Versi resmi — Jika tidak ada versi canary yang cocok, versi resmi dikembalikan.

Periksa versi konfigurasi yang cocok untuk setiap node pada halaman Listener Query di Konsol MSE.

Atur beberapa tag

Nacos mendukung injeksi beberapa pasangan tag kunci-nilai ke dalam aplikasi melalui parameter nacos.app.conn.labels. Gunakan format "k1=v1,k2=v2,k3=v3".

// Opsi 1: Atur melalui properties
Properties properties = new Properties();
properties.put(PropertyKeyConst.SERVER_ADDR, "<your-nacos-endpoint>");
properties.put("project.name", "<your-app-name>");
properties.put("nacos.app.conn.labels", "app=order-service,site=hangzhou-c,env=staging");

// Opsi 2: Atur sebagai parameter JVM
// -Dnacos.app.conn.labels="app=order-service,site=hangzhou-c,env=staging"

// Opsi 3: Atur sebagai variabel lingkungan
// nacos_app_conn_labels="app=order-service,site=hangzhou-c,env=staging"

NacosConfigService configService = new NacosConfigService(properties);

String dataId = "<your-data-id>";
String group = "<your-group>";

configService.addListener(dataId, group, new Listener() {
    @Override
    public Executor getExecutor() {
        return null;
    }

    @Override
    public void receiveConfigInfo(String configInfo) {
        System.out.println("Received config: " + configInfo);
    }
});

Implementasikan kolektor tag kustom (SPI)

Untuk logika tag yang dinamis atau kompleks, implementasikan antarmuka SPI com.alibaba.nacos.common.labels.LabelsCollector dan daftarkan sebagai layanan.

package com.example.labels;

import com.alibaba.nacos.common.labels.LabelsCollector;

import java.util.HashMap;
import java.util.Map;
import java.util.Properties;

public class CustomLabelsCollector implements LabelsCollector {

    @Override
    public String getName() {
        return "custom-labels";
    }

    @Override
    public Map<String, String> collectLabels(Properties properties) {
        Map<String, String> labels = new HashMap<>();
        // Tambahkan logika kustom untuk menentukan label
        labels.put("env", System.getenv("DEPLOY_ENV"));
        labels.put("region", System.getenv("DEPLOY_REGION"));
        return labels;
    }

    @Override
    public int getOrder() {
        return 1;
    }
}

Untuk menggunakan implementasi ini, publikasikan sebagai layanan.

Persyaratan format tag

Kunci dan nilai tag mendukung: huruf besar dan kecil, angka, garis bawah (_), tanda hubung (-), dan titik (.). Tag dalam format lain diabaikan.

Saat menentukan beberapa pasangan kunci-nilai dengan nacos.app.conn.labels, gunakan format "k1=v1,k2=v2,k3=v3". Entri tanpa nilai diabaikan. Misalnya, "k1=v1,k2" hanya menghasilkan k1=v1 yang diurai.