Pengaturan Produksi: Ketersediaan Tinggi & Multikoneksi

Dokumen ini menunjukkan kepada Anda cara mengatur klaster Ketersediaan Tinggi dalam produksi. Dokumen ini juga memberikan panduan cara mengaktifkan Multikoneksi, beserta perubahan yang diperlukan untuk klaster Multikoneksi dengan ketersediaan tinggi.

Sebelum memulai pengaturan ini, lihatlah persyaratan kami.

Untuk menyiapkan klaster Ketersediaan Tinggi:

1. Buat direktori biz untuk skrip pengaturan
2. Dapatkan file konfigurasi klien API WhatsApp Business
3. Atur variabel lingkungan database
4. Siapkan volume media lokal
5. Atur klien API WhatsApp Business
6. Verifikasikan kontainer sudah berjalan
7. Lakukan pemeriksaan kesehatan
8. Daftarkan klien API WhatsApp Business
9. Lakukan pemeriksaan kesehatan kedua

Untuk menyiapkan klaster Multikoneksi Ketersediaan Tinggi:

1. Siapkan dua partisi
2. Lakukan pemeriksaan kesehatan
3. Mulailah CoreApp ketiga untuk mempertahankan Ketersediaan Tinggi
4. Lakukan pemeriksaan kesehatan kedua

Setelah Anda selesai menyiapkan instance, Anda bisa memilih untuk meningkatkannya. Untuk mencopot penginstalan klien, ikuti langkah-langkah ini.

Sebelum Memulai

Anda akan memerlukan:

• Beberapa server komputasi untuk menjalankan berbagai komponen klien API WhatsApp Business (misalnya: Webapp, Master, dan CoreApp)

  • Untuk persyaratan sistem, lihat Apa saja persyaratan sistem server untuk menjalankan Klien API WhatsApp Business? di Pertanyaan Umum.
  • Untuk pengaturan Ketersediaan Tinggi produksi, kami merekomendasikan setidaknya 1 mesin untuk kontainer Webapp, 2 mesin untuk kontainer CoreApp, dan 2 mesin untuk kontainer Master. Muatan pada Master ringan dan Anda bisa menempatkan kontainer Master dan CoreApp pada host yang sama.
• Docker Desktop dan Docker Compose Terinstal.
• Server database mandiri yang menjalankan proses MySQL atau PostgreSQL Anda

  • Server database seharusnya tidak dijalankan pada server komputasi lain yang meng-hosting Klien API Business dan hanya berlatensi beberapa milidetik dari server komputasi lain.

• Sistem file bersama (misalnya: NFS) dipasang ke direktori lokal di semua host WebApp, Master, dan CoreApp, jika Anda ingin mendukung pengiriman dan penerimaan pesan media

  • Pastikan 755 diatur sebagai mode file pada jalur pasang dan semua subdirektorinya.

mkdir your-local-media-volume-path
mount -t nfs nfs_server_IP_addr:/shared_directory /your-local-media-volume-path

Pengaturan Klaster Ketersediaan Tinggi

Langkah 1: Buat Direktori biz untuk Skrip Pengaturan

Jalankan kode berikut di lokasi pilihan Anda untuk klien API WhatsApp Business:

mkdir ~/biz; cd ~/biz;

Langkah 2: Dapatkan File Konfigurasi Klien API WhatsApp Business

Buat klona file konfigurasi prod-multiconnect-compose.yml dan db.env dari direktori Penginstalanrepositori GitHub WhatsApp-Business-API-Setup-Scripts ke direktori ~/biz yang Anda buat di Langkah 1.

Langkah 3: Atur Variabel Lingkungan Database

Ubah variabel lingkungan database dalam file db.env di bawah direktori ~/biz untuk mencerminkan konfigurasi MySQL/PostgreSQL Anda.

WA_DB_ENGINE=MYSQL | PGSQL
WA_DB_HOSTNAME=your-database-server
WA_DB_PORT=your-database-server-port
WA_DB_USERNAME=your-database-username
WA_DB_PASSWORD=your-database-password

Langkah 4: Siapkan Volume Media Lokal

Volume media lokal (whatsappMedia:/usr/local/wamedia secara default) ditentukan dalam file prod-docker-compose.yml digunakan untuk menyimpan file media. Secara default, volume dipasang ke direktori pada mesin Docker. Atau, Anda dapat memilih untuk memasang volume media ke direktori host. Untuk mengubah titik pasang volume media, ubah definisi volume di dalam bagian services dari whatsappMedia ke jalur direktori host yang Anda gunakan.

services:
  waweb:
    ...
    volumes:
      - /your-local-media-volume-path:/usr/local/wamedia
    ...
  wacore:
    ...
    volumes:
      - /your-local-media-volume-path:/usr/local/wamedia
  ...
  master:
    ...
    volumes:
      - /your-local-media-volume-path:/usr/local/wamedia

Langkah 5: Mulailah Klien API WhatsApp Business

Untuk memulai klien API WhatsApp Business dengan 1 kontainer Webapp, 2 kontainer Master, dan 2 kontainer CoreApp yang mirip dengan diagram Pengantar Ketersediaan Tinggi, gunakan perintah berikut dengan perubahan yang diperlukan untuk lingkungan Anda (yaitu: nama host, nama pengguna host, dan jalur lokal):

# copy configuration scripts to each Webapp host, ssh to each Webapp host, execute scripts to install Webapp on the host
for host in your-webapp-hostname; do
    scp db.env prod-multiconnect-compose.yml username@$host:/local/path/
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.4 docker-compose -f /local/path/prod-multiconnect-compose.yml up -d"
    ssh username@$host $cmd waweb
done 
# copy configuration scripts to each Master host, ssh to each Master host, execute scripts to install Master on the host
for host in your-master1-hostname your-master2-hostname; do
    scp db.env prod-multiconnect-compose.yml username@$host:/local/path/
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.4 docker-compose -f /local/path/prod-multiconnect-compose.yml up -d"
    ssh username@$host $cmd master
done
# copy configuration scripts to each Coreapp host, ssh to each Coreapp host, execute scripts to install Coreapp on the host
for host in your-coreapp1-hostname your-coreapp2-hostname; do
    scp db.env prod-multiconnect-compose.yml username@$host:/local/path/
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.4 docker-compose -f /local/path/prod-multiconnect-compose.yml up -d"
    ssh username@$host $cmd wacore
done

Singkatnya, perintah di atas akan:

• Menyalin file konfigurasi prod-multiconnect-compose.yml dan db.env ke semua host Webapp (your-webapp-hostname dalam contoh ini) dan memulai layanan waweb pada host ini;
• Salin file konfigurasi prod-multiconnect-compose.yml dan db.env ke semua host Master (your-master1-hostname dan your-master2-hostname dalam contoh ini) dan mulai layanan Master pada host ini;
• Salin file konfigurasi prod-multiconnect-compose.yml dan db.env ke semua host CoreApp (your-coreapp1-hostname dan your-coreapp2-hostname dalam contoh ini) dan mulai layanan wacore pada host ini.

Langkah 6: Verifikasikan bahwa Kontainer Aktif

Anda dapat memeriksa bahwa semua kontainer memiliki status RUNNING dengan menjalankan:

EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.4 docker-compose -f prod-multiconnect-compose.yml ps

Langkah 7: Lakukan Pemeriksaan Kesehatan

Anda dapat melakukan pemeriksaan kesehatan pada klien API WhatsApp Business menggunakan panggilan API ke node health.

Output yang dihasilkan akan terlihat seperti berikut:

{
    "health": {
        "your-master1-hostname:85cdd51506fd": {
            "errors": [
              {
                  "code": 1011,
                  "title": "Service not ready",
                  "details": "Wacore is not instantiated. Please check wacore log for details."
              }
            ]
        },
        "your-master2-hostname:8dd3f5bea27d": {
            "gateway_status": "unregistered",
            "role": "primary_master"
        },
        "your-coreapp1-hostname:753efb1cf72c": {
            "errors": [
              {
                  "code": 1011,
                  "title": "Service not ready",
                  "details": "Wacore is not instantiated. Please check wacore log for details."
              }
            ]
        },
        "your-coreapp2-hostname:75d7355eaaaa": {
            "errors": [
              {
                  "code": 1011,
                  "title": "Service not ready",
                  "details": "Wacore is not instantiated. Please check wacore log for details."
              }
            ]
        }
    }
}
200

Tanggapan menunjukkan gateway_status dari unregistered sebagai gateway_status karena klien API WhatsApp Business belum terdaftar.

Langkah 8: Daftarkan Klien API WhatsApp Business

Anda dapat mendaftarkan klien API WhatsApp Business menggunakan panggilan API ke nodeaccount.

Langkah 9: Lakukan Pemeriksaan Kesehatan Kedua

Lakukan pemeriksaan kesehatan lagi pada klien API WhatsApp Business menggunakan panggilan API ke node health setelah menyelesaikan pendaftaran dan pastikan salah satu kontainer CoreApp memiliki gateway_statusconnected.

Output yang dihasilkan akan terlihat seperti berikut:

{
    "health": {
        "your-master1-hostname:85cdd51506fd": {
            "gateway_status": "disconnected",
            "role": "secondary_master"
        },
        "your-master2-hostname:8dd3f5bea27d": {
            "gateway_status": "disconnected",
            "role": "primary_master"
        },
        "your-coreapp1-hostname:753efb1cf72c": {
            "gateway_status": "connected",
            "role": "coreapp"
        },
        "your-coreapp2-hostname:75d7355eaaaa": {
            "gateway_status": "disconnected",
            "role": "coreapp"
        }
    }
}
200

Catatan: Dalam mode Ketersediaan Tinggi, hanya satu CoreApp (your-coreapp1-hostname:753efb1cf72c dalam contoh ini) yang akan terhubung ke server WhatsApp, semua node lain termasuk Master utama akan memiliki gateway_statusdisconnected. Jika your-coreapp1-hostname:753efb1cf72c terhenti, your-coreapp2-hostname:75d7355eaaaa akan menggantikannya dan terhubung ke server WhatsApp untuk mempertahankan Ketersediaan Tinggi.

Sekarang, Anda telah menyiapkan klien API WhatsApp Business dalam mode Ketersediaan Tinggi. Dalam mode ini, hanya satu Coreapp yang dapat terhubung ke server WhatsApp untuk mengirim pesan pada waktu tertentu. Jika Anda ingin memiliki beberapa CoreApp yang mengirim pesan secara bersamaan untuk meningkatkan throughput pesan, ikuti langkah-langkahnya di bagian Pengaturan Klaster Multikoneksi Ketersediaan Tinggi di bawah ini.

Pengaturan Klaster Multikoneksi Ketersediaan Tinggi

Langkah 1: Siapkan Dua Partisi

Gunakan endpoint partisi untuk menyiapkan 2 partisi. Anda seharusnya melihat tanggapan HTTP dengan status 201 Created.

Langkah 2: Lakukan Pemeriksaan Kesehatan

Anda dapat melakukan pemeriksaan kesehatan pada klien API WhatsApp Business menggunakan panggilan API ke node health untuk memeriksa semua node sudah berjalan dengan benar.

Output yang dihasilkan akan terlihat seperti berikut:

{
    "health": {
        "your-master1-hostname:85cdd51506fd": {
            "gateway_status": "disconnected",
            "role": "secondary_master"
        },
        "your-master2-hostname:8dd3f5bea27d": {
            "gateway_status": "connected",
            "role": "primary_master"
        },
        "your-coreapp1-hostname:753efb1cf72c": {
            "gateway_status": "connected",
            "role": "coreapp"
        },
        "your-coreapp2-hostname:75d7355eaaaa": {
            "gateway_status": "connected",
            "role": "coreapp"
        }
    }
}      
200    

Catatan: Dalam mode Multikoneksi dengan 2 partisi, 2 CoreApp (your-coreapp1-hostname:753efb1cf72c dan your-coreapp2-hostname:75d7355eaaaa dalam contoh ini) akan terhubung ke server WhatsApp, dan Master utama (your-master2-hostname:8dd3f5bea27d dalam contoh ini) juga akan terhubung ke server.

Langkah 3: Mulailah Coreapp Ketiga untuk Mempertahankan Ketersediaan Tinggi

Sejauh ini dalam contoh ini, Anda memiliki 2 kontainer CoreApp dan muatan pesan dibagi di antara keduanya. Namun, jika salah satu kontainer CoreApp terhenti, setengah dari pengiriman pesan Anda akan gagal. Untuk mempertahankan Ketersediaan Tinggi dalam pengaturan Multikoneksi baru ini, Anda dapat memulai CoreApp ketiga pada host CoreApp baru (

dalam contoh ini) untuk menoleransi 1 kegagalan CoreApp, yang mirip dengan diagram yang ditunjukkan pada Pengantar Multikoneksi.

Untuk memulai kontainer Coreapp ketiga, jalankan perintah berikut:

# copy configuration scripts to the 3rd Coreapp host, ssh to the Coreapp host, execute scripts to install Coreapp on the host
for host in your-coreapp3-hostname; do
    scp db.env prod-multiconnect-compose.yml username@$host:/local/path/
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.4 docker-compose -f /local/path/prod-multiconnect-compose.yml up -d"
    ssh username@$host $cmd wacore
done

Langkah 4: Lakukan Pemeriksaan Kesehatan Kedua

Lakukan pemeriksaan kesehatan lagi untuk memverifikasi bahwa semua node sudah berjalan dengan benar menggunakan panggilan API ke node health.

Output yang dihasilkan akan terlihat seperti berikut:

{
    "health": {
        "your-master1-hostname:85cdd51506fd": {
            "gateway_status": "disconnected",
            "role": "secondary_master"
        },
        "your-master2-hostname:8dd3f5bea27d": {
            "gateway_status": "disconnected",
            "role": "primary_master"
        },
        "your-coreapp1-hostname:753efb1cf72c": {
            "gateway_status": "connected",
            "role": "coreapp"
        },
        "your-coreapp2-hostname:75d7355eaaaa": {
            "gateway_status": "connected",
            "role": "coreapp"
        },
        "your-coreapp3-hostname:23b50199bec2": {
            "gateway_status": "disconnected",
            "role": "coreapp"
        }
    }
}      
200 

Kontainer CoreApp baru (your-coreapp3-hostname:23b50199bec2 dalam contoh ini) sekarang bertindak sebagai kontainer siaga, tetapi saat ini tidak terhubung ke server WhatsApp. Jika salah satu dari 2 kontainer CoreApp yang terhubung lainnya berhenti berfungsi, kontainer ketiga akan terhubung ke server WhatsApp untuk mempertahankan jumlah partisi keseluruhan sebesar 2.

Pedoman & Praktik Terbaik

Jumlah Webapp

Untuk mendukung 100-150 pesan/detik, setidaknya 2 Webapp direkomendasikan. Jika Anda ingin mencapai Ketersediaan Tinggi untuk Webapp, Anda dapat menjalankan kontainer Webapp pada lebih dari 2 host dan meng-host mereka di belakang penyeimbang muatan seperti HAProxy, Nginx, atau ELB. Alih-alih mengakses endpoint Klien API Business melalui https://your-webapp-hostname:your-webapp-port/, Anda sebaiknya menggunakan https://your-load-balancer-name:your-load-balancer-port/.

Jumlah Master

Direkomendasikan Anda menjalankan 3 Master pada host yang berbeda. Tidak ada alasan untuk memiliki lebih dari 3 Master dalam produksi berapa pun partisi yang Anda miliki. Muatan di Master ringan dan Anda bisa menempatkan bersama kontainer CoreApp.

Jumlah CoreApp

Direkomendasikan Anda memiliki shard_number + X jumlah CoreApp yang berjalan pada host yang berbeda untuk menoleransi X jumlah kegagalan host.

Meningkatkan Klien API WhatsApp Business

Variabel lingkungan WA_API_VERSION harus diperbarui ke nomor versi terbaru. Jalankan perintah berikut dengan perubahan yang diperlukan untuk lingkungan Anda (yaitu: nama host, nama pengguna host, dan jalur lokal):

# ssh to each Webapp host, execute scripts with new WA_API_VERSION to upgrade Webapp on the host
for host in your-webapp-hostname; do
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.x docker-compose -f /local/path/prod-multiconnect-compose.yml up -d"
    ssh username@$host $cmd waweb
done
# ssh to each Master host, execute scripts with new WA_API_VERSION to upgrade Master on the host
for host in your-master1-hostname your-master2-hostname; do
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.x docker-compose -f /local/path/prod-multiconnect-compose.yml up -d"
    ssh username@$host $cmd master
done
# ssh to each Coreapp host, execute scripts with new WA_API_VERSION to upgrade Coreapp on the host
for host in your-coreapp1-hostname your-coreapp2-hostname your-coreapp3-hostname; do
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.x docker-compose -f /local/path/prod-multiconnect-compose.yml up -d"
    ssh username@$host $cmd wacore
done

Untuk Pengguna Database MySQL yang Meningkatkan ke Versi 2.23.x ke Atas

Sekarang Anda dapat menggunakan layanan peningkatan database yang memungkinkan Anda untuk meningkatkan database saat aplikasi Anda masih berjalan agar terhindar dari waktu henti.

Langkah 1: Unduh file konfigurasi

File dbupgrade-compose.yml memiliki kolom yang menandakan versi kontainer.

Contoh:

services:
  dbupgrade:
      image: docker.whatsapp.biz/coreapp:v${WA_API_VERSION:-2.21.3}

Langkah 2: Mulailah kontainer

Untuk meningkatkan penginstalan, mulailah kontainer dbupgrade-service dengan variabel lingkungan WA_API_VERSION yang diatur ke versi terbaru:

EXTERNAL_HOSTNAME=$host_to_upgradedb WA_API_VERSION=new-whatsapp-version docker-compose -f dbupgrade-compose.yml up -d

Catatan: Jika Anda menggunakan orkestrasi yang memulai ulang kontainer setelah keluar apa pun kode keluarnya, mulailah layanan dengan variabel lingkungan EXIT_ON_SUCCESS yang diatur ke FALSE agar terhindar dari keluar kontainer ketika kode keluarnya adalah 0.

Langkah 3: Tunggu sampai peningkatan selesai

Jika peningkatan database berhasil, kontainer akan keluar dengan kode 0. Anda dapat menggunakan perintah Docker berikut untuk melacak status:

docker wait your-database-upgrade-container-name

Outputnya adalah kode keluar dari kontainer dbupgrade-service.

Langkah 4: Mulai ulang kontainer CoreApp dan Webapp

Mulai ulang kontainer Coreapp dan Webapp Docker dengan variabel lingkungan WA_API_VERSION yang diatur ke versi terbaru:

EXTERNAL_HOSTNAME=$host_to_upgradedb WA_API_VERSION=new-whatsapp-version docker-compose -f dbupgrade-compose.yml up -d

Untuk Pengguna Klien API WhatsApp Business yang Meningkatkan ke Versi 2.29.3 ke Atas

Jika Anda meningkatkan dari v2.29.1, v2.29.2atau mengalami masalah selama peningkatan ke versi tersebut dan harus kembali ke versi sebelumnya demi stabilitas, kami merekomendasikan Anda untuk meningkatkan ke v2.29.3, lalu jalankan perintah berikut pada kontainer Docker Webapp:

chown -R root your-media-directory/incoming your-media-directory/outgoing your-media-directory/shared

Kecuali Anda telah mengubahnya, direktori media default adalah /usr/local/wamedia.

Catatan:

• Karena penyelesaian perintah ini dapat memakan waktu berdasarkan ukuran volume media yang sudah ada sebelumnya, kami merekomendasikan untuk segera memulai perintah ini setelah Anda meningkatkan selama periode pemeliharaan.
• Perintah ini hanya mengubah kepemilikan volume media di latar belakang (Tidak ada dampak/waktu untuk operasi media atau latensi/kinerja saat sedang berjalan).
• Ini adalah jalur peningkatan hanya satu kali untuk memperbaiki masalah kompatibilitas dengan versi sebelumnya di v2.29.1 dan v2.29.2.

Menghapus penginstalan Klien API WhatsApp Business

Jika Anda perlu mereset lingkungan pengembangan Anda dengan menghapus semua kontainer, gunakan perintah berikut dengan perubahan yang diperlukan untuk lingkungan Anda (yaitu: nama host, nama pengguna host, dan jalur lokal):

# ssh to each Webapp host, execute scripts to uninstall Webapp on the host
for host in your-webapp-hostname; do
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.4 docker-compose -f /local/path/prod-docker-compose.yml down"
    ssh username@$host $cmd waweb
done
# ssh to each Master host, execute scripts to uninstall Master on the host
for host in your-master1-hostname your-master2-hostname; do
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.4 docker-compose -f /local/path/prod-docker-compose.yml down"
    ssh username@$host $cmd master
done
# ssh to each Coreapp host, execute scripts to uninstall Coreapp on the host
for host in your-coreapp1-hostname your-coreapp2-hostname your-coreapp3-hostname; do
    cmd="EXTERNAL_HOSTNAME=$host WA_API_VERSION=2.23.4 docker-compose -f /local/path/prod-docker-compose.yml down"
    ssh username@$host $cmd wacore
done

Pemecahan Masalah

Untuk mengumpulkan catatan dari semua kontainer di host, jalankan perintah berikut:

EXTERNAL_HOSTNAME=$host_to_collect_logs docker-compose -f /local/path/prod-multiconnect-compose.yml logs > debug_output.txt

Untuk mengumpulkan catatan dari layanan spesifik, tambahkan nama layanan (misalnya: waweb, master1, wacore1) ke perintah docker-compose logs.

EXTERNAL_HOSTNAME=$host_to_collect_logs docker-compose -f /local/path/prod-multiconnect-compose.yml logs waweb > debug_output.txt

Anda dapat menemukan catatan dalam file debug_output.txt di direktori saat ini.