Bereitstellung mit Amazon Web Services

Hier erfährst du, wie du die WhatsApp Business API mit Amazon Web Services (AWS) verwendest. Der Prozess lässt sich in zwei Hauptschritte unterteilen:

1. Bereitstellung des WhatsApp Business API-Clients
2. Konfiguration des WhatsApp Business API-Clients

Nach dem Setup kannst du ein Upgrade des Clients durchführen. Wenn du die Webapp und CoreApp einmal beide neu starten musst, führe diese Schritte aus.

Erste Schritte

Bevor du beginnst, musst du die folgenden Schritte ausführen:

• Einrichten einer AWS-Konto-ID
• Erstellen eines AWS-Schlüsselpaars
• Abonnieren eines CentOS 7-Image
• Bereitstellen in einer unterstützten Region

Einrichten einer AWS-Konto-ID

Du musst ein gültiges AWS-Konto einrichten und mit den Vorgängen in AWS vertraut sein. WhatsApp stellt CloudFormation-Vorlagen für die einfache Bereitstellung des WhatsApp Business API-Clients zur Verfügung. Mehr dazu erfährst du unter Erste Schritte mit dem AWS-Ressourcencenter.

Erstellen eines AWS-Schlüsselpaars

Du musst ein neues Schlüsselpaar erstellen, um auf die EC2-Instanz zuzugreifen, die durch die WhatsApp Business API-Vorlage erstellt wurde. Du kannst auch ein zuvor erstelltes Schlüsselpaar verwenden. Informationen zum Erstellen und Verwenden von Schlüsselpaaren mit einer EC2-Instanz findest du in der Dokumentation zu Amazon EC2-Schlüsselpaaren.

Abonnieren eines CentOS 9-Images

Der WhatsApp Business API-Client verwendet ein CentOS 9-Image (in AWS Marketplace verfügbar). Die Nutzungsbedingungen sollten vor Verwendung der Vorlage überprüft und akzeptiert werden. Wenn du die Bedingungen nicht akzeptierst, führt dies beim Erstellen der Vorlage zu einem Fehler.

So überprüfst und akzeptierst du das CentOS 9 AMI-Image:

1. Gehe zur Seite AWS Marketplace: CentOS 9 (x86_64) - with Updates HVM.
2. Klicke oben rechts auf Continue to Subscribe und dann auf den Button Accept Terms.

Unterstützte Regionen

Die WhatsApp Business API-Vorlagen verwenden den Ressourcentyp EFS, der nicht in allen AWS-Regionen verfügbar ist. Daher werden derzeit nur die folgenden Regionen unterstützt:

• N. Virginia (us-east-1)
• Ohio (us-east-2)
• N. California (us-west-1)
• Oregon (us-west-2)
• Mumbai (ap-south-1)
• Seoul (ap-northeast-2)
• Singapore (ap-southeast-1)
• Sydney (ap-southeast-2)
• Tokyo (ap-northeast-1)
• Frankfurt (eu-central-1)
• Irland (eu-west-1)

FAQs

Bereitstellung

Schritt 1: [Optional] Netzwerk-Setup

Das VPC-Netzwerk (Virtual Private Cloud) wird in der Regel erstellt, wenn du ein AWS-Konto registrierst. Darüber hinaus können mehrere Anpassungen und Zugriffsbeschränkungen erforderlich sein, die für ein bestimmtes Unternehmen spezifisch sind.

Wenn die VPC-Netzwerkinfrastruktur bereits erstellt wurde, kannst du diesen Schritt überspringen. Andernfalls kannst du anhand der folgenden Vorlage die Netzwerkinfrastruktur in AWS erstellen.

Netzwerkanforderungen

• Innerhalb einer Region müssen mindestens zwei Subnetze in unterschiedlichen Verfügbarkeitszonen vorhanden sein. Andernfalls schlägt die Vorlagenerstellung beim Erstellen der RDS-Ressource (Datenbank) fehl.
• Der eingehende Zugriff auf HTTP (Port: 80), HTTPS (Port: 443) und SSH (Port: 22) muss zugelassen werden. Aus Sicherheitsgründen wird dringend empfohlen, HTTPS und nicht HTTP zu verwenden.

Bereitstellen der Netzwerkvorlage:

1. Rufe die CloudFormation-Konsole für deine Region auf (z. B. eu-west-1).
2. Wähle Create a stack aus.
3. Lade die Datei wa_ent_net.yml von GitHub herunter und speichere sie lokal.
4. Wähle Upload a template file als Vorlagenquelle aus und lade die in Schritt 3 heruntergeladene Vorlagendatei hoch.
   

   Stack erstellen
5. Klicke auf Next.
6. Gib auf dem Bildschirm Specify stack details die Parameterwerte entsprechend der unten stehenden Tabelle ein:

Parameter

Konfiguration der Verfügbarkeitszonen

VPC-Konfiguration

Konfiguration des öffentlichen Subnetzes

Konfiguration des privaten Subnetzes

Schritt 2: Konfigurationsdateien von DB- und Monitoring-Stack hochladen

Bevor du den WhatsApp Business API-Stack auf AWS bereitstellst, musst du zuerst die Konfigurationsdateien referenzierter Substacks in einen S3-Bucket hochladen, auf den du Lesezugriff hast.

1. Erstelle einen neuen S3-Bucket oder verwende einen vorhandenen S3-Bucket, auf den du Lesezugriff hast.
2. Lade die Dateien wa_ent_db.yml und wa_ent_monitoring.yml von GitHub herunter und lade beide in den in Schritt 1 erwähnten S3-Bucket hoch.
3. Wähle die Datei wa_ent_db.yml in der Objektliste aus und kopiere ihre URL. Sie muss das folgende Format aufweisen: https://xxx.s3.<avalability_zone>.amazonaws.com/wa_ent_db.yml.
4. Ersetze in der Datei wa_ent.yml den Wert der TemplateURL im DB-Stack durch die Objekt-URL aus Schritt 3 und speichere die Datei.
5. Wähle die Datei wa_ent_monitoring.yml in der Objektliste aus und kopiere ihre URL. Sie muss das folgende Format aufweisen: https://xxx.s3.<avalability_zone>.amazonaws.com/wa_ent_monitoring.yml.
6. Ersetze in der Datei wa_ent.yml den Wert der TemplateURL im Monitoring-Stack durch die Objekt-URL aus Schritt 5 und speichere die Datei.

Hochladen in S3-Bucket

Schritt 3: Bereitstellung der WhatsApp Business API

WhatsApp Enterprise ist die Hauptvorlage, mit der alle Ressourcen (außer dem Netzwerk) erstellt werden, die für den WhatsApp Business API-Client benötigt werden. Wie bereits erwähnt, kann bei Bedarf anhand dieser Vorlage auch eine Datenbank-Ressource erstellt werden.

Bereitstellen des WhatsApp Business API-Clients:

1. Rufe die CloudFormation-Konsole für deine Region auf (z. B. eu-west-1).
2. Wähle Create a stack aus.
3. Lade die Datei wa_ent.yml von GitHub herunter und speichere sie lokal.
4. Wähle Upload a template file als Vorlagenquelle aus und lade die in Schritt 3 heruntergeladene Vorlagendatei hoch.
   

   Stack erstellen
5. Klicke auf Next.
   
6. Anschließend hast du die Möglichkeit, Parameter einzugeben. In der nachstehenden Tabelle findest du die Parameterbeschreibungen.
   
7. Nachdem du alle Parameter (in den nachstehenden Tabellen) festgelegt hast, klicke auf der Seite Configure stack options auf Next. Du kannst alle erforderlichen Änderungen entsprechend deinen Präferenzen vornehmen. Klicke dann auf Next.
8. Auf der Seite Review stack wird eine Zusammenfassung von Parameterwerten und Stack-Optionen angezeigt. Nachdem du diese verifiziert hast, aktiviere beide Kontrollkästchen im Abschnitt Capabilities und klicke auf Submit, um die Stack-Erstellung zu starten.
   Hinweis: Die Bereitstellung dauert ungefähr 20 bis 30 Minuten.
   

Parameter

Allgemeine Konfiguration

Netzwerkkonfiguration

Containerkonfiguration

Datenbankkonfiguration

Protokollierungskonfiguration

Dateisystemkonfiguration

Sicherheitskonfiguration

Zugriffspunkt der WhatsApp Business API

Diese Parameter sind für Grafana-Dashboards erforderlich, um Anwendungskennzahlen zu Überwachungszwecken abzurufen.

Grafana

Ausgabe nach der Bereitstellung

Nach der erfolgreichen Erstellung der Vorlage werden die folgenden Parameter angezeigt:

• Load balancer name: Hostname des Load Balancer, der auf den WhatsApp Business Platform API-Client zugreift
• Database hostname: Hostname der Datenbank, die bei der Vorlagenerstellung erstellt oder bereitgestellt wird
• Database port number: Portnummer für die Datenbankverbindung
• ECS cluster name: Name des erstellten ECS-Clusters
• Log retention days: Anzahl der Tage, für die Protokolle aufbewahrt werden sollen
• DB connection CA: Wert der Zertifizierungsstelle für die Datenbankverbindung, sofern konfiguriert
• DB connection cert: Wert des Zertifikats für die Datenbankverbindung, sofern konfiguriert
• DB connection key: Wert des Schlüssels für die Datenbankverbindung, sofern konfiguriert
• Grafana: URL des Grafana-Dashboards
• ShardCount: Anzahl der für die WhatsApp Business Platform API zu konfigurierenden Shards

SSH-Sicherheitsregeln bearbeiten

Die vom Stack erstellten Sicherheitsregeln erlauben dem gesamten Traffic standardmäßig, die EC2-Instanzen über SSH, die API-Endpunkte und das Grafana-Dashboard über HTTPs sowie die Cadvisor- und Prometheus-Container zu erreichen. Aus Sicherheitsgründen wird dringend empfohlen, nicht notwendige Zugriffe zu unterbinden. In diesem Abschnitt werden als Beispiel die Schritte zur Aktualisierung der SSH-Sicherheitsregel beschrieben. Du solltest SSH-Zugriff immer ausschließlich auf Traffic beschränken, dem du vertraust.

1. Führe in der EC2-Konsole „Security Groups“ (beispielsweise EC2 Management Console (amazon.com)) die folgenden Schritte aus:
   1. Wähle rechts oben die richtige Region aus.
   2. Wähle die Sicherheitsgruppe aus, die <stackName>-EcsSecurityGroup enthält, und wechsle dann zum Tab Inbound Rules.
      

      Regeln für eingehenden Traffic bearbeiten
   3. Wähle Edit inbound rules aus und aktualisiere die Spalte Source so, dass nur vertrauenswürdigem Traffic (z. B. My IP) der Zugriff auf EC2-Hosts über SSH erlaubt wird.
      
   4. Nachdem du alle Sicherheitsregeln angepasst hast, klicke auf Save rules, um die Änderungen anzuwenden.
   5. Wiederhole diese Änderungen für die Sicherheitsgruppe, die "<stackName>-ms-xxx-EcsSecurityGroup" enthält, um SSH-Zugriff für den Monitoring-Stack einzuschränken.

Konfiguration des WhatsApp Business API-Clients

Nach erfolgreicher Bereitstellung des WhatsApp Business API-Clients muss dieser für die Inbetriebnahme konfiguriert werden.

Schritt 1: Telefonregistrierung

Ausführlichere Informationen zur Registrierung von Telefonnummern findest du im Leitfaden zu Telefonnummern.

Lade das base64-codierte Zertifikat über deinen WhatsApp Account im Facebook Business Manager auf dem Tab Phone Numbers des WhatsApp Manager herunter.

Nachdem du die entsprechende Telefonnummer ausgewählt und das base64-codierte Zertifikat heruntergeladen hast, musst du den WhatsApp Business API-Client über den account-Node registrieren. Weitere Informationen findest du in der Dokumentation zur Registrierung.

Schritt 2: Shards festlegen

Nach der Erstellung des Stacks musst du die Anzahl der aktiven Coreapp-Instanzen mit dem shards-API-Aufruf erhöhen, um den gewünschten Durchsatz zu erzielen. Die Anzahl der Shards findest du im Ausgabeabschnitt des Stacks.

Schritt 3: App-Einstellungen aktualisieren

Die Konfiguration von Web-Rückrufen mit der WhatsApp Business API und anderen Parametern ist in der Dokumentation zu App-Einstellungen beschrieben. Zum Erzielen eines stabilen Durchsatzes werden die folgenden App-Einstellungen empfohlen.

 {
    "settings": {
        "application": {
            "callback_backoff_delay_ms": 3000,
            "callback_persist": true,
            "db_garbagecollector_enable": false, # change this to true when there are no ongoing messaging campaigns
            "heartbeat_interval": 5,
            "max_callback_backoff_delay_ms": 900000,
            "media": {
                "auto_download": [
                    "document",
                    "image",
                    "video",
                    "voice",
                    "sticker",
                    "audio"
                ]
            },
            "notify_user_change_number": true,
            "pass_through": false,
            "sent_status": true,
            "show_security_notifications": false,
            "skip_referral_media_download": false,
            "unhealthy_interval": 30,
            "wa_id": "12245552741",
            "webhooks": {
                "max_concurrent_requests": 24,
                "message": {
                    "delivered": true,
                    "read": true,
                    "sent": true
                },
                "url": "<YOUR_WEBHOOK_SERVER_URL>"
            }
        }
    },
    "meta": {
        "api_status": "stable",
        "version": "2.41.3"
    }
}

      
      
    

Schritt 4: [Optional] SSL-Konfiguration

Beim Erstellen des WhatsApp Business API-Clients erstellt der Client standardmäßig ein selbstsigniertes Zertifikat. Das Zertifikat der Zertifizierungsstelle (Certification Authority, CA), mit dem das selbstsignierte Zertifikat erstellt wurde, wird unter Umständen benötigt, um den Endpunkt des WhatsApp Business API-Clients zu überprüfen und eine Sicherheitswarnung hinsichtlich der Vertraulichkeit des Zertifikats zu vermeiden.

Du kannst das CA-Zertifikat herunterladen und lokal speichern, um die Sicherheitswarnung hinsichtlich der Vertraulichkeit des Zertifikats zu umgehen. Alternativ kannst du ein eigenes Zertifikat hochladen. Weitere Informationen findest du in der Dokumentation zum certificate-Node.

Schritt 5: Setup-Überprüfung

Nach erfolgreichem Abschluss der Konfigurations- und Registrierungsschritte können Nachrichten gesendet und empfangen werden, um die Grundfunktionalität des WhatsApp Business API-Clients zu überprüfen. Eine ausführliche Beschreibung hierzu findest du in der Dokumentation zu Nachrichten.

Nach dem erfolgreichen Empfang einer Nachricht veröffentlicht der WhatsApp Business API-Client mithilfe von POST den Nachrichtenstatus bzw. Details zum Webhook, der in Schritt 3 konfiguriert wurde.

Wenn deine Nachricht empfangen wurde: Herzlichen Glückwunsch, du bist fertig! Weitere Informationen zu den verfügbaren API-Endpunkten findest du in der Referenzdokumentation.

Neustart von Coreapp und Webapp

Um den WhatsApp Business API-Client neu zu starten, führe in der ECS-Konsole (beispielsweise https://us-west-2.console.aws.amazon.com/ecs/home?region=us-west-2#/clusters) folgende Schritte aus:

1. Wähle rechts oben die richtige Region aus.
2. Wähle den entsprechenden Cluster aus der Liste aus.
3. Wähle auf dem Tab Services den Servicenamen aus, der WAEntService enthält.
4. Wähle den Tab Tasks aus. Es sollte typischerweise nur eine Aufgabe vorhanden sein sowie eine ID aus Hexadezimalziffern.
5. Klicke im Fenster Tasks oben rechts auf Stop und dann erneut auf Stop, wenn du dazu aufgefordert wirst.

Dadurch werden die Webapp und die CoreApp angehalten. Kurz darauf werden die Webapp und die CoreApp von der AWS-Infrastruktur neu gestartet.

Upgrade

In diesem Abschnitt wird das Upgrade des WhatsApp Business API-Clients und der CloudFormation-Vorlage (CFN-Vorlage) beschrieben. Bei diesem Upgrade kommt es zu einer Ausfallzeit. Sende währenddessen also keine Nachrichten. Sende erst wieder Nachrichten, wenn das Upgrade abgeschlossen ist.

Du kannst die CFN-Vorlage und die WhatsApp Business API-Clientversion gleichzeitig aktualisieren. Führe dazu die folgenden Schritte aus:

1. Wähle in Schritt 5 der Upgrade-Anweisungen für den WhatsApp Business API-Client anstelle von Use current template die Option Replace current template aus.
2. Wähle im Abschnitt Specify template die Option „Upload a template file“ aus und wähle dann die neueste von GitHub heruntergeladene Vorlage.

Upgrade des WhatsApp Business API-Clients

1. Rufe die CFN-Konsole auf (beispielsweise https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks?filter=active).
2. Wähle rechts oben die richtige Region aus.
3. Wähle den WhatsApp Business API-Client-Stack aus, der bereits erstellt wurde.
4. Klicke auf Update.
5. Wähle auf der Seite Prerequisite - Prepare template die Option Replace current template aus. Wähle im Abschnitt Specify template die Option „Upload a template file“ aus und wähle dann die neueste von GitHub heruntergeladene Vorlage. Klicke auf Next.
6. Ändere auf der Seite Specify stack details den Wert für WhatsApp Business API Client (container) version in die gewünschte Version. Ändere KEINEN anderen Parameter. Klicke auf Next.
7. Klicke auf der Seite Configure stack options auf Next.
8. Wähle auf der Seite Review „I acknowledge that AWS CloudFormation might create IAM resources with custom names“ aus. Überprüfe im Abschnitt Change set preview alle unerwarteten Änderungen. Wenn es unerwartete Änderungen gibt oder du nicht sicher bist, wende dich bitte an WhatsApp Direct Support. Klicke auf Update stack. Der Status der Stack-Aktualisierung kann in der CFN-Konsole nachverfolgt werden und ändert sich von UPDATE_IN_PROGRESS in UPDATE_COMPLETE, sobald die Aktualisierung abgeschlossen ist.

Upgrade von WhatsApp-CFN-Vorlagen

1. Rufe die CFN-Konsole (CloudFormation) auf (beispielsweise https://us-west-2.console.aws.amazon.com/cloudformation/home?region=us-west-2#/stacks?filter=active).
2. Wähle rechts oben die richtige Region aus.
3. Wähle den WhatsApp Business API-Client-Stack aus, der bereits erstellt wurde.
4. Klicke auf Update.
5. Wähle auf der Seite Prerequisite - Prepare template die Option Replace current template aus. Wähle im Abschnitt Specify template die Option „Upload a template file“ aus und wähle dann die neueste von GitHub heruntergeladene Vorlage. Klicke auf Next.
6. Gib auf der Seite Specify Stack Details die entsprechenden Parameter gemäß den Informationen aus den vorherigen Abschnitten ein. Klicke auf Next.
7. Klicke auf der Seite Configure Stack Options auf Next.
8. Wähle auf der Seite Review „I acknowledge that AWS CloudFormation might create IAM resources with custom names“ aus. Überprüfe im Abschnitt Change set preview alle unerwarteten Änderungen. Wenn es unerwartete Änderungen gibt oder du nicht sicher bist, wende dich bitte an WhatsApp Direct Support. Klicke auf Update stack. Der Status der Stack-Aktualisierung kann in der CFN-Konsole nachverfolgt werden und ändert sich von UPDATE_IN_PROGRESS in UPDATE_COMPLETE, sobald die Aktualisierung abgeschlossen ist.

So können bei inaktivem System manuell die Kosten gesenkt werden (optional)

Es ist üblich, dass Unternehmen für eine zeitlich begrenzte Kampagne eine Umgebung mit hohem Durchsatz einrichten und in der kampagnenfreien Zeit eine kostengünstige Umgebung betreiben möchten. In diesem Abschnitt findest du Vorschläge, wie du das AWS-Setup manuell herunterskalieren kannst, um Kosten zu sparen.

1. Führe in der ECS-Konsole (beispielsweise Amazon ECS) die folgenden Schritte aus:
   1. Wähle rechts oben die richtige Region aus.
   2. Wähle den entsprechenden Cluster aus der Liste aus.
   3. Wähle auf dem Tab Services den Dienstnamen aus, der WAEntCoreappService enthält. Wähle Edit Service aus und aktualisiere den Wert für „Desired tasks“ in 0.
      

      Konfiguration der Bereitstellung
   4. Wiederhole Schritt C für alle anderen Dienste, einschließlich WAEntWebService, WAEntMasterService und HostExporterService.
   5. Gehe zurück zur Cluster-Seite und vergewissere dich auf dem Tab Tasks, dass aktuell keine Aufgaben der oben genannten Dienste ausgeführt werden.
2. Führe in der EC2-Konsole „Auto Scaling Groups“ (beispielsweise Auto Scaling groups | EC2 Management Console (amazon.com)) die folgenden Schritte aus:
   1. Wähle rechts oben die richtige Region aus.
   2. Wähle die automatische Skalierungsgruppe aus, deren Name HAECSAutoScalingGroup enthält, und wähle dann Edit. Aktualisiere die Werte für „Desired capacity“ und „Minimum capacity“ in 3.
      

      Gruppengröße
   3. Wähle die automatische Skalierungsgruppe aus, deren Name HAECSAutoScalingGroupWeb enthält, und wähle dann Edit. Aktualisiere die Werte für „Desired capacity“ und „Minimum capacity“ in 2.
3. (Optional) Wenn für „Type of message“ einer der Bildtypen als Ausgangswert festgelegt ist, kannst du die EC2-Instanztypen durch die kostengünstigere Option c5.large ersetzen.
   1. Wähle in der EC2-Konsole „Launch Templates“ die entsprechende Startvorlage in der Liste aus.
   2. Wähle „Actions - Modify template (create new version)“ aus.
      

      Konsole „Launch Templates“
   3. Aktualisiere den Instanztyp im Abschnitt Instance type in c5.large und wähle dann Create template version.
      

      Instanztyp
   4. Wähle in der EC2-Konsole „Auto Scaling Groups“ die automatische Skalierungsgruppe des Stacks aus, dessen Name HAECSAutoScalingGroup enthält.
   5. Wähle im Bereich Launch template die Option Edit aus.
   6. Wähle die in Schritt 3c erstellte neue Startvorlage aus und wähle Update.
      

      Startvorlage
4. Führe in der RDS-Konsole (beispielsweise RDS Management Console (amazon.com)) die folgenden Schritte aus:
   1. Wähle rechts oben die richtige Region aus.
   2. Wähle die entsprechende Aurora-Datenbank in der Liste aus.
   3. Wähle Modify aus und aktualisiere die DB-Instanzklasse in r5.xlarge.
      

      Instanzkonfiguration
5. Führe in der ECS-Konsole (beispielsweise Amazon ECS) die folgenden Schritte aus:
   1. Wähle rechts oben die richtige Region aus.
   2. Wähle den entsprechenden Cluster aus der Liste aus.
   3. Wähle auf dem Tab Services den Dienstnamen aus, der WAEntCoreappService enthält. Wähle Edit Service aus und aktualisiere den Wert für „Desired tasks“ in 3.
   4. Wähle auf dem Tab Services den Dienstnamen aus, der HostExporterService enthält. Wähle Edit Service aus und aktualisiere den Wert für „Desired tasks“ in 3.
   5. Wähle auf dem Tab Services den Dienstnamen aus, der WAEntWebService enthält. Wähle Edit Service aus und aktualisiere den Wert für „Desired tasks“ in 2.
   6. Wähle auf dem Tab Services den Dienstnamen aus, der WAEntMasterService enthält. Wähle Edit Service aus und aktualisiere den Wert für „Desired tasks“ in 2.
6. Warte, bis alle Dienste die gewünschte Anzahl von Aufgaben gestartet haben. Sobald alle Aufgaben ausgeführt werden, setze die Shards mithilfe von Set Shards API auf 2 zurück.
7. Validiere die Integrität des Systems mithilfe der Health API. Es kann auch eine Nachricht gesendet und empfangen werden, um die grundlegende Funktionalität des WhatsApp Business API-Clients zu validieren. Eine ausführliche Beschreibung hierzu findest du in der Dokumentation zu Nachrichten.