media server logo
PreiseAnmeldenAuf AWS startenEmpfohlene Region: Frankfurt.
API-DokumentationÜbersicht
Allgemeine Einstellungen
Ports
Cluster-Knoten
Zusätzliche Dienstprogramme
Speicherziele
Dokumentationsnavigation ein- oder ausblenden
Callaba-Startseite

Cluster-Knoten

Verwenden Sie Cluster-Knoten, um Engine-Instanzen in einer Callaba-Bereitstellung mit mehreren Knoten einzubinden, zu aktivieren, zu prüfen und zu entfernen.

FunktionKapazität zu einem Cluster hinzufügen

Geeignet, wennEine Bereitstellung benötigt zusätzliche oder regionale vertrauenswürdige Engine-Knoten.

Anderes Modul verwenden, wennVerwenden Sie eine einzelne Engine-Instanz, wenn keine verteilte Kapazität oder regionale Platzierung erforderlich ist.

1Knoten registrieren2Zustand synchronisieren3Workload zuweisen
POST /api/clusterNodes/create
10 Endpunkte

Voraussetzungen

Alle Methoden erfordern einen administrativen x-access-token. Knoten müssen über die erforderlichen Netzwerkpfade erreichbar sein, die vorgesehene Rolle verwenden und eindeutige Identitäts- und Adressinformationen haben.

Funktionen

  • create, update, getAll, getCount und getById verwalten Knoteneinträge.
  • attachNode und detachNode ändern die Clustermitgliedschaft.
  • start und stop steuern einen registrierten Knoten.
  • remove löscht einen nicht mehr benötigten Knoteneintrag.

Beispiel-Workflow

  1. Erstellen Sie den Knoten mit seiner Rolle und erreichbaren Adresse.
  2. Binden Sie den Knoten in den vorgesehenen Cluster ein.
  3. Starten Sie ihn und prüfen Sie seinen Zustand, bevor Sie Workloads zuweisen.
  4. Stoppen und trennen Sie ihn vor Wartungsarbeiten oder der Entfernung.

Typische Anwendungsfälle

  • Fügen Sie einen regionalen Verarbeitungsknoten für ein Ereignis in der Nähe seiner Contribution-Feeds hinzu.
  • Halten Sie einen Testknoten von Produktionszuweisungen getrennt.
  • Entlasten und trennen Sie einen Knoten für Wartungsarbeiten, ohne den Cluster zu löschen.

Einschränkungen und Fehlerbehebung

Falsche Rollen, doppelte Adressen, nicht erreichbare Hosts oder fehlende Netzwerkberechtigungen können das Anbringen oder Starten verhindern. Das Lösen oder Stoppen eines Knotens kann sich auf die ihm zugewiesenen Ressourcen auswirken, also verschieben oder stoppen Sie zuerst abhängige Arbeiten.

Nächste Schritte

Nachdem der Knoten aktiv ist, erstellen Sie die Ingest- oder Verarbeitungsressourcen, die im Cluster ausgeführt werden sollen.

REST-Lösungsrezept

Einen Worker an einen Callaba-Cluster anbinden

Erstellen Sie den Node-Eintrag, verbinden Sie ihn mit dem geprüften Master und starten Sie ihn erst nach Netzwerk- und Versionsprüfung.

  1. Node erstellenRegistrieren Sie den geprüften Host und seine Rolle.POST /api/clusterNodes/create
  2. Node anbindenVerbinden Sie den Node mit der vorgesehenen Cluster-Beziehung.POST /api/clusterNodes/attachNode
  3. Worker startenStarten Sie erst nach erfolgreicher Anbindung und Zustandsprüfung.POST /api/clusterNodes/start

Cluster-Methoden benötigen Administratorzugriff. Prüfen Sie Erreichbarkeit und Kompatibilität vor Produktions-Workloads.

POST
/api/clusterNodes/create
Admin-Token erforderlich

Registrieren Sie mit dieser Methode einen neuen internen Cluster-Knoten. Nutzen Sie den Aufruf, um den Cluster zu erweitern, einen untergeordneten Knoten in die vertrauenswürdige Topologie aufzunehmen oder einen separaten Testknoten vor einer Bereitstellung vorzubereiten.

Bei untergeordneten Knoten ist das API-Token des Knotens Teil des Vertrauensaufbaus. Verwenden Sie hier keine öffentliche IP-Adresse: Diese Cluster-Beziehung ist für die interne Infrastruktur vorgesehen.

Primärer Steuerknoten

Verwenden Sie dies, wenn ein interner Knoten als zentraler Koordinierungspunkt des Clusters fungieren soll und sich die übrigen Knoten an ihm ausrichten.

Primärer Steuerknoten
Code kopieren
curl --request POST \
  --url http://localhost/api/clusterNodes/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Primary cluster node",
  "host": "10.20.0.10",
  "node_type": "CLUSTER_NODES_TYPE_MASTER",
  "active": true
}'
Eingebundener Slave-Knoten

Verwenden Sie diese Voreinstellung, wenn ein untergeordneter Knoten dem vertrauenswürdigen internen Cluster beitreten soll. Für eine erfolgreiche Einbindung ist das API-Token des untergeordneten Knotens erforderlich.

Eingebundener Slave-Knoten
Code kopieren
curl --request POST \
  --url http://localhost/api/clusterNodes/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Istanbul slave node",
  "host": "10.20.0.25",
  "node_type": "CLUSTER_NODES_TYPE_SLAVE",
  "api_token": "<child_node_jwt_token>",
  "active": true
}'
Test- oder Validierungsknoten

Verwenden Sie dies, wenn ein Knoten für Validierungs-, Test- oder Einzelprüfungen bereitgestellt werden soll, bevor er Teil eines Produktionspfads wird.

Test- oder Validierungsknoten
Code kopieren
curl --request POST \
  --url http://localhost/api/clusterNodes/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Test validation node",
  "host": "10.20.0.40",
  "node_type": "CLUSTER_NODES_TYPE_TEST",
  "active": false
}'
Parameter im Request-Body
Identität
name
string
Direktlink kopieren

Dashboard-Bezeichnung: Knotenname.

Intern verwendeter, gut lesbarer Knotenname.

node_type
string
Direktlink kopieren

Dashboard-Bezeichnung: Typ.

Unterstützte Werte sind CLUSTER_NODES_TYPE_MASTER, CLUSTER_NODES_TYPE_SLAVE, und CLUSTER_NODES_TYPE_TEST.

Verbindung
host
string
Direktlink kopieren

Dashboard-Bezeichnung: Host.

Interne Knotenadresse. Das Dashboard warnt Betreiber, hier keine öffentliche IP zu verwenden.

Vertrauen
api_token
string
Direktlink kopieren

Dashboard-Bezeichnung: API-Token.

JWT des untergeordneten Knotens für die Einbindung eines Slave-Knotens. Das Feld ist nur relevant, wenn der Knotentyp CLUSTER_NODES_TYPE_SLAVE ist.

Laufzeit
active
boolean
Direktlink kopieren

Dashboard-Bezeichnung: Aktiviert.

Steuert, ob der Knoten direkt nach der Bereitstellung aktiv sein soll.

Cluster-Knoten erstellen
Code kopieren
curl --request POST \
  --url http://localhost/api/clusterNodes/create \
  --header 'x-access-token: <your_api_token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Istanbul slave node",
  "host": "10.20.0.25",
  "node_type": "CLUSTER_NODES_TYPE_SLAVE",
  "api_token": "<child_node_jwt_token>",
  "active": true
}'
Antwort
success
boolean
Direktlink kopieren

Der Erstellungsaufruf bestätigt die Akzeptanz mit einer Erfolgsantwort.

Antwort: Cluster-Knoten erstellen
JSON
Code kopieren
{
  "success": true
}
POST
/api/clusterNodes/getCount
Admin-Token erforderlich
POST
/api/clusterNodes/getAll
Admin-Token erforderlich
POST
/api/clusterNodes/getById
Admin-Token erforderlich
POST
/api/clusterNodes/update
Admin-Token erforderlich
POST
/api/clusterNodes/start
Admin-Token erforderlich
POST
/api/clusterNodes/stop
Admin-Token erforderlich
POST
/api/clusterNodes/attachNode
Admin-Token erforderlich
POST
/api/clusterNodes/detachNode
Admin-Token erforderlich
DELETE
/api/clusterNodes/remove
Admin-Token erforderlich
Zurück zuPortsWeiter zuZusätzliche Dienstprogramme