288 docs getaggt mit "Technology"

API-Ansätze

Aktiviert ein CkArchive: stellt die archivspezifische CrateDB-Tabelle bereit und überführt das Archiv in den Zustand Activated. Führen Sie dies einmal aus, nachdem Sie die Archiv-Entität per rt-Import importiert haben.

Fügt einen neuen Identity Provider für Active Directory hinzu.

Fügt einen neuen Client mit dem Grant-Typ 'AuthorizationCode' hinzu.

Fügt einen neuen Identity Provider für Microsoft Azure Entra ID hinzu.

Fügt einen neuen Client mit dem Grant-Typ 'ClientCredentials' hinzu.

Fügt einen Client zu einer Gruppe hinzu.

Weist einem Client eine Rolle zu

Fügt einem aktivierten Raw- oder Time-Range-Archiv eine berechnete Spalte hinzu und füllt sie per Backfill auf. Die Spalte wird atomar sichtbar, sobald der Backfill abgeschlossen ist. (AB#4189)

Fügt einen benannten Kontext hinzu oder aktualisiert ihn.

Fügt einen neuen Client mit dem Grant-Typ 'device code' hinzu.

Fügt eine untergeordnete Gruppe zu einer übergeordneten Gruppe hinzu.

Fügt einen neuen Identity Provider hinzu.

Fügt einen neuen Identity Provider für die tenantübergreifende Authentifizierung über einen übergeordneten Tenant hinzu.

Fügt einen neuen Identity Provider für Open LDAP hinzu.

Gewährt einem Client den Zugriff auf einen Scope.

Fügt einen Benutzer zu einer Gruppe hinzu.

Fügt einen Benutzer zu einer Rolle hinzu

Aggregationsabfragen berechnen Zusammenfassungswerte (Durchschnitte, Summen, Extremwerte) über Zeitreihen-Datenpunkte hinweg, anstatt einzelne Zeilen zurückzugeben. Verwenden Sie diese, wenn Sie berechnete Kennzahlen statt Rohdaten benötigen – zum Beispiel die durchschnittliche Spannung über die letzte Stunde oder die insgesamt pro Maschine erzeugte Energie.

GraphQL erlaubt es, Daten abzufragen und zu verändern. Mutationen sind Operationen wie Erstellen, Aktualisieren und Löschen. Dieses Kapitel beschreibt, wie Daten aktualisiert werden können.

Wendet ein Overlay-URI-Set (RedirectUris / PostLogoutRedirectUris / AllowedCorsOrigins) auf einen blueprint-verwalteten Client an. Neue Einträge werden mit Source = 'overlay:<OverlayName>' geschrieben und beim erneuten Anwenden des Blueprints durch den Preservation-Durchlauf von Schritt 2a beibehalten. Idempotent — Duplikate werden stillschweigend übersprungen (jede Source). Mindestens eine der drei URI-Listen muss angegeben werden.

Association Roles definieren die Beziehungstypen zwischen Entitäten. Jede Role legt die Multiplizität und Benennung für beide Richtungen der Beziehung fest (inbound und outbound).

Assoziationen definieren Beziehungen zwischen Entitäten im Runtime-Modell. Dieses Kapitel beschreibt, wie Sie Assoziationen abfragen und navigieren.

Hängt eine bestehende Datenbank an einen Tenant an.

Attribute sind wiederverwendbare Property-Definitionen, die auf Typen angewendet werden können. Jedes Attribut besitzt einen Wertetyp und optionale Einschränkungen.

OctoMesh verwendet OAuth 2.0 und OpenID Connect (OIDC) für die Authentifizierung. Diese Seite erklärt, wie die Authentifizierung funktioniert, welche Flows unterstützt werden und was während des Anmeldevorgangs geschieht.

Ruft den Authentifizierungsstatus gegenüber den konfigurierten Identity Services ab.

AutoIncrements ermöglichen die automatische Wertegenerierung für Attribute, wenn Entitäten in das Repository eingefügt werden. Sie stellen eindeutige, fortlaufende Werte für Attribute wie Kundennummern, Dokument-IDs oder jeden anderen Bezeichner sicher, der eine automatische Nummerierung erfordert.

Stellt einen dauerhaften Hintergrund-Backfill in die Warteschlange, der ein Rollup über die GESAMTE Historie seines Quellarchivs befüllt / zurücksetzt, ohne dass ein Zeitstempel angegeben wird (AB#4269 / AB#4286). Ermittelt den frühesten Zeitstempel des Quellarchivs und stellt eine Neuberechnung von [sourceMin, now) in die Warteschlange; die aufwändige Arbeit läuft im Hintergrund und wird daher nie durch einen Client-Timeout abgebrochen. Gibt sofort die ID des Pending-Jobs zurück. Verwenden Sie -w/--wait, um zu pollen, bis der Job abgeschlossen ist. Ein No-op, wenn das Quellarchiv keine Daten enthält.

Benutzer

Dieses Kapitel enthält Best Practices für das Schreiben effizienter und wartbarer GraphQL-Queries und -Mutationen.

Dieser Abschnitt liefert Best Practices und Empfehlungen für die Erstellung von Construction Kits.

OctoMesh bietet eingebaute Werkzeuge zur Verwaltung von Construction-Kit-(CK-)Modellbibliotheken über Tenants hinweg. Dazu gehören das Durchsuchen verfügbarer Bibliotheken aus Katalogen, das Prüfen der Kompatibilität, das Auflösen von Abhängigkeiten und das Importieren von Bibliotheken mit vollständiger Abhängigkeitsauflösung.

Blueprints sind versionierte, deklarative Bündel aus Construction-Kit-(CK-)Modellen und Runtime-Seed-Daten, die einen Tenant initialisieren (bootstrappen) — und ihn über seine gesamte Lebensdauer hinweg weiter verwalten. Ein Blueprint kann installiert, erneut angewendet, aktualisiert, zurückgerollt und deinstalliert werden und kann von anderen Blueprints abhängen. Versionierte Migrationsskripte transformieren die Tenant-Daten, wenn die eigene Version eines Blueprints vorwärts wandert.

Cancels one execution that is still waiting in an adapter pool's queue. It never runs.

Zeigt den Abhängigkeitsbaum für ein CK-Modell aus einem Katalog an.

Pre-Flight-Prüfung für das Upgrade/die Migration eines CK-Modells.

Modelle mit ckLanguage 1).

Setzt einen Tenant auf die Werkseinstellungen zurück, indem der Construction Kit und das Runtime-Modell gelöscht werden.

Entfernt Overlay-URI-Einträge aus jedem blueprint-verwalteten Client im Tenant. Ohne -overlayName*' entspricht. Mit -overlayName<name>' entsprechen. Destruktiv — typischerweise vor einem bereinigten DumpTenant-Export verwendet; der Operator kann danach mit Apply-IdentityOverlay erneut anwenden (idempotent, No-op, wenn der Zustand übereinstimmt).

Leert den Cache eines Tenants

In OAuth 2.0 ist ein Client jede Anwendung, die Zugriff im Namen eines Benutzers oder für sich selbst anfordert. API-Scopes definieren, welche Operationen ein Client ausführen darf. Der Identity Service verwaltet beides pro Tenant.

Playbooks mit mehreren Befehlen für typische octo-cli-Nutzungsszenarien. Jeder Schritt hat seinen eigenen kopierbaren Codeblock – fügen Sie sie nacheinander ein. Die vollständige Dokumentation pro Befehl finden Sie im Abschnitt Command Reference in der Seitenleiste.

ck-language-2-compiler-messages}

Konfiguriert den aktiven Kontext.

Der Construction Kit definiert das Schema und die Struktur Ihres Datenmodells. Anders als das Runtime-Modell, das die tatsächlichen Dateninstanzen speichert, enthält der Construction Kit die Metadaten, die festlegen, welche Arten von Entitäten existieren können, sowie deren Attribute, Beziehungen und Einschränkungen.

GraphQL ermöglicht das Abfragen und Mutieren von Daten. Mutationen sind Operationen wie Erstellen, Aktualisieren und Löschen. Dieses Kapitel beschreibt, wie Daten erstellt werden können.

Erstellt einen neuen Tenant und richtet den aktuellen Benutzer als Admin ein.

Erstellt ein Admin-Provisioning-Mapping in einem Ziel-Tenant.

Fügt eine neue API-Ressource hinzu.

Erstellt einen neuen API-Scope.

Fügt ein neues API-Secret für eine API-Ressource hinzu.

Fügt ein neues API-Secret für einen Client hinzu.

Creates a data permission (AB#4972)

Creates a policy bound to a data permission (AB#4972)

Erstellt eine E-Mail-Domain-Gruppenregel.

Erstellt ein External-Tenant-User-Mapping.

Erstellt ein Fixup-Skript

Erstellt eine Gruppe.

Erstellt eine neue Rolle

Erstellt ein neues Benutzerkonto

Dieses Dokument erläutert die grundlegenden Datenmodellierungskonzepte in OctoMesh, darunter Construction Kits, Runtime-Entitäten und Streamdaten.

Manche Pipelines existieren, um im Moment einer bestimmten Person zu dienen: das klarste

GraphQL ermöglicht das Abfragen und Mutieren von Daten. Mutationen sind Operationen wie Erstellen, Aktualisieren und Löschen. Dieses Kapitel beschreibt, wie Daten gelöscht werden können.

Löscht einen bestehenden Tenant.

Löscht ein Admin-Provisioning-Mapping aus einem Ziel-Tenant.

Löscht eine API-Ressource.

Löscht einen API-Scope.

Löscht ein Secret einer API-Ressource.

Löscht ein Secret eines Clients.

Löscht die archivspezifische CrateDB-Tabelle und markiert die CkArchive-Entität als soft-deleted. Destruktiv — historische Daten gehen verloren.

Löscht einen Client.

Deletes a data permission including its policies

Löscht eine E-Mail-Domain-Gruppenregel.

Löscht ein External-Tenant-User-Mapping.

Löscht eine Gruppe.

Löscht einen Identity Provider.

Löscht eine Rolle

Deletes the pre-sweep dump of a secret sweep run before it expires (requires SecretManagement). Use -y to skip confirmation.

Löscht einen Benutzer

Stellt einen bestimmten Datenfluss bereit.

Triggers a deploy of a deployment site. The Communication Operator creates the deployment site resources; workloads are deployed separately via DeployWorkload.

Diese Seite listet die gehosteten MCP-(Model Context Protocol)-Services-Endpunkte auf und wie man sie jeweils bei Ihrem KI-Client registriert. Für die Registrierungsmechanik siehe Getting started.

Stellt eine Pipeline-Definition auf dem zugehörigen Adapter bereit.

Stellt alle Trigger für den aktuellen Tenant bereit.

Löst die Bereitstellung eines Workloads (Adapter oder Application) über dessen übergeordneten Pool aus.

Trennt einen untergeordneten Tenant ab. Die Datenbank bleibt erhalten und kann mit Attach erneut angehängt werden.

Deaktiviert den AI Adapter für den aktuellen Tenant. Die eingespielte AgentConfig und das CK-Modell werden nicht entfernt; das erneute Aktivieren ist idempotent.

Deaktiviert ein CkArchive: Übergang in den Zustand Disabled (Daten bleiben erhalten). Nur aus dem Zustand Activated zulässig.

Deaktiviert den Communication Controller für den aktuellen Tenant.

Deaktiviert die Reporting Services für den aktuellen Tenant.

Deaktiviert die Streamdaten-Dienste für den aktuellen Tenant.

Display-Name-Regeln erlauben es einem Construction-Kit-Typ zu deklarieren, wie Instanzen dieses Typs für Menschen beschriftet werden sollen. Ist eine Regel definiert, berechnet die Engine bei jedem Speichern die schreibgeschützten Systemfelder rtDisplayName und rtDisplayDescription für jede Entität, sodass alle Konsumenten — GraphQL-Abfragen, Refinery-Studio-Listen, MeshBoard-Entitätsselektoren und -Picker — ein konsistentes, aussagekräftiges Label anzeigen, ohne die Benennungslogik in jeder Anwendung zu duplizieren.

Eine Downsampling-Abfrage reduziert die Dichte von Zeitreihendaten, indem sie einen Zeitbereich in gleich große Buckets unterteilt und auf jeden Bucket eine Aggregationsfunktion anwendet. Dies ist für die Visualisierung großer Datensätze auf Dashboards und in Diagrammen unverzichtbar – anstatt Tausende von Rohdatenpunkten zu übertragen, erhalten Sie eine handhabbare Anzahl zusammengefasster Werte.

Sichert einen Tenant in eine Datei

E-Mail-Domain-Gruppenregeln weisen Benutzer automatisch Gruppen zu, basierend auf der Domain ihrer E-Mail-Adresse. Wenn sich ein Benutzer registriert oder sich zum ersten Mal anmeldet, prüft der Identity Service seine E-Mail-Adresse gegen die konfigurierten Regeln und fügt ihn passenden Gruppen hinzu.

Im OctoMesh-Umfeld spielen Adapter und Pipelines eine entscheidende Rolle als das Bindegewebe zwischen der OctoMesh-Plattform und externen Datenquellen und Diensten. Diese kleinen, aber leistungsstarken Software-Bausteine sind darauf ausgelegt, Kommunikation und Datenaustausch über eine vielfältige Menge von Endpunkten hinweg zu ermöglichen, darunter APIs, Dateisysteme, Datenbanken, Message-Broker sowie weitere benutzerdefinierte oder standardisierte Protokolle. Um unterschiedlichen architektonischen Anforderungen und Bereitstellungsszenarien gerecht zu werden, unterscheidet OctoMesh zwei Haupttypen von Adaptern: Edge Adapter und Mesh Adapter.

Im Zentrum von OctoMesh steht das Konzept der Construction Kits. Diese Kits dienen als grundlegender Baustein zur Definition von Objektmodellen und liefern den wesentlichen Kontext, der Daten in umsetzbare Erkenntnisse verwandelt. Mit OctoMesh können Sie Modelle erstellen, die auf Ihre spezifischen Anforderungen abgestimmt sind, sodass Sie Daten auf eine Weise formen können, die für Ihre Organisation sinnvoll ist.

Willkommen zum OctoMesh Technology Guide, Ihrer umfassenden Ressource, um die transformative Kraft von OctoMesh für die Architektur und Verwaltung robuster Data-Mesh-Lösungen zu nutzen. Dieser Leitfaden ist als Ihr Wegweiser durch die weitreichenden Funktionen von OctoMesh konzipiert: Er beleuchtet die zugrunde liegenden Konzepte, liefert detaillierte Schritt-für-Schritt-Anleitungen und bietet praxisnahe Rezepte, mit denen Sie das volle Potenzial Ihrer Daten ausschöpfen.

Aktiviert den AI Adapter für den aktuellen Tenant. Der Communication Controller muss zuerst aktiviert sein (führen Sie vorher EnableCommunication aus).

Reaktiviert ein zuvor deaktiviertes Archiv: Übergang Disabled → Activated. Validiert die Spaltenpfade erneut gegen das aktuelle CK-Modell; kein DDL.

Aktiviert den Communication Controller für den aktuellen Tenant.

Aktiviert die Reporting Services für den aktuellen Tenant.

Aktiviert die Streamdaten-Dienste für den aktuellen Tenant.

Enums dienen dazu, eine Menge vordefinierter Konstanten festzulegen, die verschiedene Zustände, Typen oder Konfigurationen innerhalb der Bibliothek repräsentieren können. Enums sind in ein Runtime Entity Object eingebettet und benötigen keine Navigation über Assoziationen.

Enums definieren eine feste Menge erlaubter Werte für ein Attribut. Jeder Enum-Wert hat einen numerischen Schlüssel, einen Namen und eine optionale Beschreibung.

Führt eine Pipeline aus und gibt die Ausführungs-ID zurück.

Exportiert die Zeilendaten eines Archivs in ein herunterladbares ZIP. Lassen Sie sowohl --fromUtc als auch --toUtc weg, um das gesamte Archiv zu exportieren; geben Sie sie an, um das halboffene Intervall [fromUtc, toUtc) zu exportieren.

Plant einen Job, um den Runtime-Modell-Graphen zu exportieren, indem RtId's und Typ als Ausgangspunkt angegeben werden. Die Datei wird über das Argument -f angegeben. Die Datei wird nach Abschluss des Jobs im ZIP-Format heruntergeladen.

Plant einen Job, um Runtime-Modelle mithilfe einer Abfrage zu exportieren. Die Datei wird über das Argument -f angegeben. Die Datei wird nach Abschluss des Jobs im ZIP-Format heruntergeladen.

Dieses Kapitel beschreibt, wie Fehler in GraphQL-Antworten zurückgegeben werden und wie sie behandelt werden.

Importiert alle CK-Modelle, die ein Update oder eine Reparatur benötigen. Verwenden Sie -w zum Warten, -y zum Überspringen der Bestätigung.

Fixup-Skripte sind MongoDB-kompatible Skripte, die auf Datenbanken für Wartungs-, Migrations- und Datenkorrekturaufgaben angewendet werden können. Sie werden vom Bot-Dienst in einer definierten Reihenfolge ausgeführt und gewährleisten so konsistente und vorhersehbare Datenbankänderungen.

Mehrere OctoMesh-Funktionen erlauben es Ihnen, eine Formel einzugeben – einen kleinen numerischen Ausdruck, der

Friert ein CkRollupArchive zum angegebenen Zeitstempel ein. Monoton — wird abgelehnt, wenn der neue Wert früher als der aktuelle FrozenUntil liegt. Der Orchestrator erzeugt keine Buckets mehr, deren bucketEnd in den eingefrorenen Bereich fällt; bereits aggregierte Zeilen bleiben erhalten.

Generiert CA- und Service-/Server-Zertifikate zum Betrieb des OctoMesh-Operators

Ruft die Konfiguration eines bestimmten Adapters ab.

Ruft aggregierte Node-Deskriptoren von allen verbundenen Adaptern ab.

Shows what an adapter pool has queued and what it currently has leased out.

Ruft alle Adapter des aktuellen Tenants ab.

Ruft Admin-Provisioning-Mappings für einen Ziel-Tenant ab.

Gibt den Status des AI-Credential-Lease (Ablaufzeiten + Generation) für den aktiven Tenant zurück. Der Token-Klartext wird niemals offengelegt.

Ruft alle API-Ressourcen ab.

Ruft alle API-Scopes ab.

Ruft alle Secrets einer API-Ressource ab.

Ruft alle Secrets eines Clients ab.

Zeigt den Verlauf der Blueprint-Anwendungen für den aktuellen Tenant an.

Ruft einen Client anhand seiner ID ab.

Listet die Sub-Tenants auf, in die ein ClientCredentials-Client automatisch provisioniert wurde.

Ruft alle Clients ab.

Ruft die On-Demand-Lifecycle-Konfiguration des Tenants ab (Scale-to-Zero, AB#4914).

Ruft den Status eines bestimmten Datenflusses ab.

Gets all data permissions with their policies and role grants

Gets all deployment sites for the current tenant.

Ruft eine E-Mail-Domain-Gruppenregel anhand der ID ab.

Ruft alle E-Mail-Domain-Gruppenregeln ab.

Ruft ein External-Tenant-User-Mapping anhand der ID ab.

Ruft External-Tenant-User-Mappings ab.

Ruft eine Gruppe anhand der ID ab.

Ruft alle Gruppen ab.

Ruft alle Identity Provider ab.

Gibt die neueste Pipeline-Ausführung zurück.

Ruft den Debug-Zustand einer Pipeline ab.

Gibt die Debug-Point-Nodes für eine bestimmte Pipeline-Ausführung zurück.

Gibt die Ausführungshistorie der Pipeline zurück.

Ruft das Pipeline-JSON-Schema für einen bestimmten Adapter ab.

Ruft den Deployment-Status einer Pipeline ab.

Ruft Rollen ab.

Ruft den Aktivierungszustand der Funktionen des aktuellen Tenants ab (Stream Data, Communication, Reporting, AI Services).

Ruft den dauerhaften Provisioning-Lifecycle-Zustand eines untergeordneten Tenants ab.

Ruft alle untergeordneten Tenants ab.

Diese Seite führt Sie durch die Registrierung der MCP-(Model Context Protocol)-Services bei einem KI-Client und den ersten authentifizierten Tool-Aufruf. Die gehosteten Endpunkte sind auf der Seite Deployments aufgeführt.

Ruft Benutzer ab.

Listet jeden Adapter / jede Application im aktiven Tenant auf, dessen ChartName übereinstimmt.

Grants a data permission to a role

graphql-mapping}

Gruppen sind organisatorische Einheiten, die die Rollenverwaltung vereinfachen. Anstatt jedem Benutzer einzeln Rollen zuzuweisen, weisen Sie einer Gruppe Rollen zu und fügen dann Benutzer zu dieser Gruppe hinzu.

Diese Seite ist die architektonische Grundlage für Streamdaten: das mentale Modell und das Vokabular, das Sie benötigen, bevor Sie entweder die vollständige Referenz Stream Data Archives oder das Deep-Dive Rollups & recompute lesen. Sie erklärt, wie die Teile zusammenpassen – die Aufteilung auf zwei Stores, die drei Archivtypen, wie Zeilen gespeichert werden, wie ein Archiv seinen Lebenszyklus durchläuft und was auf dem Schreib- und Lesepfad geschieht – und übergibt dann an die Referenz- und Deep-Dive-Seiten für die erschöpfenden Details.

Identity Provider ermöglichen es Benutzern, sich mit externen Identitätssystemen bei OctoMesh zu authentifizieren. Jeder Tenant kann mehrere Provider unabhängig konfigurieren.

Importiert Archivzeilendaten aus einem Export-ZIP in ein Zielarchiv. Das Zielarchiv muss während des Imports deaktiviert (Disabled) sein (siehe DisableArchive). Der Bot prüft, dass das Export-Schema mit dem Zielarchiv übereinstimmt, bevor Zeilen geschrieben werden.

Plant einen Import-Job für Construction-Kit-Dateien. Die Datei wird mit dem Argument -f angegeben. Um auf den Job zu warten, verwenden Sie das Argument -w.

Importiert ein CK-Modell aus einem Katalog mit allen Abhängigkeiten. Verwenden Sie -w, um auf den Abschluss zu warten.

Plant einen Import-Job für Runtime-Dateien. Die Datei wird mit dem Argument -f angegeben. Um auf den Job zu warten, verwenden Sie das Argument -w.

OctoMesh verwendet Communication Operators, um verteilte Rechenressourcen mithilfe von Kubernetes zu verwalten. Die Communication Operators sind für die Verwaltung des Lebenszyklus der Workloads eines Deployment Sites (Adapter und Applications) verantwortlich, einschließlich deren Erstellung, Aktualisierung und Löschung.

Installiert ein Blueprint in den aktuellen Tenant. CK-Modelle werden geladen und Seed-Daten werden per Upsert importiert.

interfaces}

Zeigt installierte CK-Modell-Bibliotheken mit ihrer Katalogverfügbarkeit an. Verwenden Sie --needs-action zum Filtern.

Listet alle Blueprints auf, die derzeit auf dem aktiven Tenant installiert sind.

Listet Blueprints auf, die über die konfigurierten Kataloge verfügbar sind.

Listet CK-Modelle aus Katalogen auf. Verwenden Sie -cn, um nach Katalog zu filtern, und -q zum Suchen.

Listet die verfügbaren CK-Modell-Katalogquellen auf.

Listet alle konfigurierten Kontexte auf. Übergeben Sie -n, um Details zu einem einzelnen Kontext anzuzeigen.

Listet die neuesten Neuberechnungs-Jobs für ein Rollup-Archiv auf (neueste zuerst, auf 50 begrenzt) — zur Fehlersuche, warum eine Neuberechnung fehlgeschlagen ist.

Listet jedes Rollup-Archiv auf, das an das angegebene Quell-CkArchive angehängt ist — Runtime-ID, Status, Zeitplan, Watermark, Freeze-Zustand.

Meldet sich bei den konfigurierten Identity Services an.

Nicht-interaktive Anmeldung über OAuth2 clientcredentials. Liest die Anmeldedaten aus den Argumenten -id/-s oder aus den Umgebungsvariablen OCTOCLICLIENTID/OCTOCLICLIENT_SECRET. Der Tenant stammt aus dem aktiven Kontext.

Die OctoMesh MCP (Model Context Protocol) Services sind der Model-Context-Protocol-Server für OctoMesh. Er stellt die vollständige administrative Oberfläche der Plattform – Tenants, Identity, Blueprints, Communication Adapter, Zeitreihenarchive, generisches Construction-Kit-Entity-CRUD und Aggregationsabfragen – als rund 208 typisierte Tools bereit, die KI-Assistenten (Claude Code, Claude Desktop und jeder andere MCP-fähige Client) über den MCP-Transport Streamable HTTP aufrufen.

method-definitions}

Mit dem Erstellen von Bibliotheken beginnen

Wenn sich ein Construction-Kit-(CK-)Modell zu einer neuen Version weiterentwickelt, müssen bestehende Runtime-Entitäten in den Tenant-Datenbanken möglicherweise aktualisiert werden, um dem neuen Schema zu entsprechen. CK-Modell-Migrationen automatisieren diesen Prozess, indem sie versionierte Transformationsskripte definieren, die Entitätsdaten während des Modellimports aktualisieren (Typen umbenennen, Attribute ändern usw.).

Modelle sind Container, die zusammengehörige Types, Attribute, Enums und Records gruppieren. Jedes Modell hat einen Namen, eine Version und kann von anderen Modellen abhängen.

Weist eine oder mehrere Pipelines von ihrem aktuellen Adapter einem neuen Ziel-Adapter zu. Jede Pipeline wird atomar verschoben; Fehler bei einzelnen Pipelines brechen den Batch nicht ab. Quell- und Ziel-Adapter müssen dieselbe CkTypeId teilen.

octo-cli ist die Kommandozeilenschnittstelle zum Verwalten und Administrieren von OctoMesh. Sie bietet Befehle zum Konfigurieren von Diensten, zum Verwalten von Tenants, Benutzern, Identity Providern und mehr.

Diese Anleitung führt Sie durch die lokale Bereitstellung von OctoMesh mithilfe der offiziellen OctoMesh-Helm-Charts in einem lokalen kind-Cluster (Kubernetes in Docker) – demselben Deployment-Modell, das OctoMesh in realen Clustern verwendet.

Adapter, die nur gelegentlich genutzt werden — zum Beispiel ein Adapter, der auf Anfrage Dokumente erzeugt, oder einer, der einmal pro Nacht Daten importiert — müssen nicht rund um die Uhr laufen. Mit dem On-Demand-Lifecycle skaliert OctoMesh einen solchen Adapter nach einer Phase der Inaktivität auf null Replicas herunter und weckt ihn automatisch auf, sobald er wieder benötigt wird. Adapter, die Live-Datenströme verarbeiten, laufen dauerhaft weiter.

Persistierte Abfragen sind gespeicherte Abfragedefinitionen, die als Runtime-Entitäten abgelegt werden. Anstatt jedes Mal alle Abfrageparameter anzugeben, erstellen Sie eine Abfragedefinition einmal und führen sie über ihre rtId aus. Das ist nützlich für Dashboard-Widgets, wiederkehrende Berichte und jedes Szenario, in dem dieselbe Abfrage wiederholt ausgeführt werden muss.

Edge- und Mesh-Pipelines ermöglichen den Datenfluss zwischen der Edge- und der Mesh-Umgebung (Cloud). Die Edge-Pipelines sind für die Vorverarbeitung der Daten verantwortlich, bevor diese an die Mesh-Pipelines gesendet werden. Die Mesh-Pipelines sind für die Verarbeitung der Daten in der Cloud-Umgebung verantwortlich.

Refinery Studio macht die Identität einer Pipeline dort sichtbar und verwaltbar, wo Sie

Zeigt eine Vorschau der Änderungen, die ein Blueprint-Update vornehmen würde, ohne sie anzuwenden.

Backfill: provisioniert einen markierten ClientCredentials-Client in jeden vorhandenen Sub-Tenant des aktiven Kontext-Tenants. Idempotent.

Provisioniert einen markierten ClientCredentials-Client manuell in einen bestimmten Sub-Tenant.

Provisioniert den aktuellen Benutzer in einem Ziel-Tenant.

range-retention-preview}

Löst eine optimistische Neuberechnung eines Rollup-Archivs über [from, to) aus (oder fasst sie zusammen). Gibt den resultierenden Job-Snapshot zurück (Zustand, Zählungen, Fehlergrund).

Recomputes rtDisplayName/rtDisplayDescription of a tenant's entities from the CK display rules (idempotent, runs asynchronously).

Konfiguriert den Log-Level für Dienste neu

Records sind zusammengesetzte Wertetypen, die verwandte Attribute zusammenfassen. Anders als Typen werden Records direkt in Entitäten eingebettet, statt eigenständige Entitäten mit eigenen Runtime-IDs zu sein.

Löst ein einmaliges AI-Credential-Ticket ein und speichert die Anthropic-Abonnement-Tokens auf dem AI Adapter. Läuft anonym – der Ticket-Code authentifiziert den Aufruf, es ist kein OctoMesh-Login erforderlich. Die tokenbezogenen Argumente (-at -rt -aex -rex) sind für Entwickler-Smoke-Tests optional; fehlende Werte werden standardmäßig auf ein Fake-Paar mit einem weit in der Zukunft liegenden Ablaufdatum gesetzt.

Aktualisiert die Blueprint-Katalog-Caches im Asset Repository. Verwenden Sie -cn, um einen bestimmten Katalog zu aktualisieren.

Aktualisiert die CK-Modell-Katalog-Caches. Verwenden Sie -cn, um einen bestimmten Katalog zu aktualisieren.

Was in OctoMesh r3.5.0 neu ist und was sich für Betreiber ändert (System.Communication 4.x, Deployment Sites, Adapter Pools und Leasing, Auflösung von Blueprint-Abhängigkeiten).

Entfernt einen Client aus einer Gruppe.

Entfernt eine Rolle von einem Client

Entfernt eine berechnete Spalte aus einem Archiv. Wird abgelehnt, wenn eine andere berechnete Spalte sie noch referenziert. (AB#4189)

Entfernt einen benannten Kontext.

Entfernt eine untergeordnete Gruppe aus einer übergeordneten Gruppe.

Entfernt einen Benutzer aus einer Gruppe.

Entfernt einen Benutzer aus einer Rolle

OctoMesh bietet umfassende Backup- und Wiederherstellungsfähigkeiten für Repositories über das octo-cli-Werkzeug. Diese

Starts a secret sweep job: re-encrypts all Secret attributes with the active key (Reprotect, default), encrypts remaining legacy values (Encrypt), removes values whose key id is not in the key ring (CleanupUnreadable, requires -y) or only counts them (Verify). Use -w to wait, -y to skip confirmation.

Öffnet die Provisionierung eines Tenants erneut, damit der Hintergrund-Reconciler sie abschließt.

Setzt das Passwort eines Benutzers zurück

Stellt einen Tenant aus einer Dump-Datei wieder her

Restores the pre-sweep dump of a secret sweep run into the same tenant, replacing its data (requires SecretManagement). Use -y to skip confirmation, -w to wait.

Dieses Kapitel beschreibt gängige Query-Muster zum Abrufen von Construction-Kit-Metadaten. Die Construction-Kit-API ist ausschließlich lesend – Sie fragen die Modellstruktur ab, können sie aber nicht über GraphQL verändern.

Wiederholt die Aktivierung nach einem vorherigen DDL-Fehler. Nur aus dem Zustand Failed zulässig.

Widerruft das AI-Credential-Lease des aktiven Tenants. Neue Sitzungen können erst gestartet werden, wenn ein neues Abonnement registriert wurde. Der Ciphertext wird für Audit-Zwecke aufbewahrt.

Revokes a data permission from a role

Setzt den Watermark des Rollups zurück (auf die Bucket-Grenze abgeschnitten), sodass nachfolgende Orchestrator-Ticks den zurückgesetzten Bereich neu aggregieren. Destruktiv: Zeilen in diesem Bereich sind vorübergehend nicht synchron, bis der Orchestrator aufgeholt hat.

Diese Seite ist der an Ingenieure gerichtete Begleiter zu Stream Data Archives. Sie erklärt, wie ein RollupArchive seine abgeleiteten Aggregationen korrekt hält, während sich die zugrunde liegenden Daten ändern – das Erkennungskriterium, das Dirty-Windows-Ledger, der Abhängigkeitsgraph, der periodische Orchestrator und der optimistische atomare Swap, der Leser durchgehend auf einem konsistenten Snapshot hält.

Rotates the client secret of an adapter's pipeline service account. The previous secret stops working immediately, and the adapter's pipelines / data flows must be redeployed afterwards before the new secret takes effect.

Fixup-Skripte ausführen

GraphQL ermöglicht das Abfragen und Mutieren von Daten. Mutationen sind Operationen wie Erstellen, Aktualisieren und Löschen. Dieses Kapitel beschreibt, wie Daten erstellt, abgerufen, aktualisiert und gelöscht werden können. Es bietet eine Referenz für die GraphQL-Scalar-Typen, Input-Typen und Enums, die in der OctoMesh-GraphQL-API verwendet werden.

Der SearchFilter bietet Textsuchfunktionen über mehrere Attribute einer Entität hinweg. Er ist für textbasierte Suchen optimiert und wird typischerweise für Suchfelder in Listenansichten verwendet.

Werte von Secret-Attributen werden mit einem Key Ring verschlüsselt, den jeder Service mit Engine über seine Konfiguration erhält. Dieser Leitfaden richtet sich an den Betrieb: was der Schlüssel ist, wie er ausgeliefert wird, wie er gesichert und rotiert wird, wie bestehende Klartext-Zugangsdaten migriert werden und wie das Ergebnis überwacht wird.

Der Attribut-Werttyp Secret speichert Zugangsdaten — Passwörter, Client Secrets, API-Schlüssel, Bot-Tokens, private Schlüssel, Refresh Tokens — verschlüsselt. Die Engine erzwingt das: Ein Secret-Wert wird bei jedem Schreiben verschlüsselt, keine öffentliche API gibt ihn zurück, und Lesende sehen nur, ob ein Wert gesetzt ist.

Diese Seite beschreibt, wie die GraphQL-API des Asset Repository, die REST-API der Identity Provider, MCP und octo-cli Attribute vom Werttyp Secret behandeln. Die Regel in einem Satz: Sie können ein Secret schreiben und sehen, ob es gesetzt ist — keine API gibt den Wert zurück.

Shows the encryption status of Secret attributes: environment status (key ring, active and known key ids, strict mode, recurring Verify), recent sweep runs with their dump state and the last sweep report (counts per form and key id, unreadable secrets to re-enter). Never shows secret values.

Ein Service Account ist die Identität, die eine Pipeline verwendet, wenn sie

Schaltet das Flag AutoProvisionInChildTenants an einem vorhandenen ClientCredentials-Client um. Das Umschalten auf true führt kein automatisches Backfill durch — verwenden Sie dafür ProvisionClientInExistingTenants.

Legt die On-Demand-Lifecycle-Konfiguration des Tenants fest (Scale-to-Zero, AB#4914). Runtime-Konfiguration — wirksam ohne erneutes Deployen des Controllers; '-sze false' ist der Not-Aus pro Tenant.

Switches a data policy between Enforce and AuditOnly (the operator flip, AB#4974)

Aktiviert oder deaktiviert die Debug-Erfassung für eine Pipeline.

Richtet die Identity Services ein

Eine Simple Query ruft rohe Zeitreihenzeilen aus CrateDB ab. Sie wählen aus, welche Spalten zurückgegeben werden, und können Filter, Sortierung und Zeitraumeinschränkungen anwenden. Dies ist der grundlegendste Streamdaten-Abfragetyp – verwenden Sie ihn, wenn Sie einzelne Datenpunkte statt aggregierter Zusammenfassungen benötigen.

Ein Stream Data Archive ist die Einheit für Konfiguration und Speicherung von Zeitreihendaten in OctoMesh. Jedes Archiv ist eine versionierte, typisierte CrateDB-Tabelle pro Tenant, die eine kuratierte Menge von Attributpfaden eines Construction-Kit-Typs erfasst. Archive haben einen strengen Lebenszyklus (Created → Activated → Disabled / Failed), ein nach der Aktivierung unveränderliches Schema und ein dreistufiges Aktivierungs-Gate (Instanz → Tenant → Archiv), das bestimmt, ob die Datenebene geöffnet ist.

Dieses Kapitel beschreibt, wie System Queries erstellt werden. Einen Überblick über System Queries und ihre Anwendungsfälle finden Sie unter System Queries.

Dieses Kapitel beschreibt, wie System Queries aktualisiert werden. Einen Überblick über System Queries und ihre Anwendungsfälle finden Sie unter System Queries.

Systemabfragen sind wiederverwendbare Abfragekonfigurationen, die im Repository gespeichert werden. Sie erlauben es Ihnen, eine Abfrage einmal zu definieren und sie von mehreren Stellen aus nur über ihre ID auszuführen.

Dieser Leitfaden erklärt, was geschieht, wenn Tenants erstellt, angehängt oder wiederhergestellt werden, und welche Schritte Sie in jedem Szenario ausführen müssen.

OctoMesh unterstützt ein hierarchisches Tenant-Modell, bei dem ein übergeordneter Tenant Benutzer in untergeordneten Tenants authentifizieren kann. Dies ermöglicht es Organisationen, ein einziges Benutzerverzeichnis zu pflegen und gleichzeitig Zugriff auf mehrere isolierte Tenants zu gewähren.

Streamdaten werden immer in UTC gespeichert. Viele Fragen werden jedoch in ziviler (Wanduhr-)Zeit für einen bestimmten Ort gestellt: „Wie waren die Werte **gestern**? diese Woche? letzten Monat?" – gemeint sind die lokalen Tages-/Wochen-/Monatsgrenzen einer gewählten Zeitzone, nicht ein UTC-Tag, der gegen den lokalen verschoben ist.

Die MCP-(Model Context Protocol)-Services stellen rund 208 Tools bereit (MCP Services 3.4, Oktober 2026), gruppiert in die unten aufgeführten Familien. Die meisten Platform-Admin-Tools spiegeln den entsprechenden octo-cli-Befehl (snakecase-Namen – z. B. CLI CreateTenant → MCP createtenant); die Aggregations- und Persisted-Query-Tools spiegeln die GraphQL-Transient-Query-Oberfläche des Asset Repository.

Transiente Abfragen erlauben es Ihnen, Runtime-Entitäten dynamisch mit konfigurierbaren Spaltenpfaden abzufragen. Anders als bei regulären Abfragen, bei denen die zurückgegebenen Felder in der GraphQL-Abfrage selbst definiert werden, geben transiente Abfragen Daten in einer tabellenartigen Struktur mit Zeilen und Zellen zurück.

Häufige Fehlermodi und wie man sie behebt. Die MCP-(Model Context Protocol)-Services werfen niemals aus einem Tool heraus – jedes Problem kommt als IsSuccess: false plus einer ErrorMessage zurück. Lesen Sie zuerst die Meldung; die Tabelle unten ordnet die typischen Meldungen den Grundursachen zu.

Types definieren die Struktur von Entitäten im Runtime-Modell. Jeder Typ besitzt Attribute, kann von einem Basistyp erben und kann an Assoziationen mit anderen Typen teilnehmen.

service coreServices(common:meshLogo)[Core Services] in central

Adapter führen Pipelines aus, und eine Pipeline besteht aus Nodes. Es gibt Nodes, die allen Adaptern gemeinsam sind, und es gibt Nodes, die für jeden Adapter spezifisch sind. Zum Beispiel bringt der Modbus-Adapter Modbus-Nodes mit, der OPC-UA-Adapter bringt OPC-UA-Nodes mit usw.

Die Integration von OctoMesh mit SAP bietet eine nahtlose und effiziente Möglichkeit, Daten zwischen den beiden Systemen auszutauschen. Durch die Nutzung des SAP NetWeaver SDK

In OctoMesh sind Datenpipelines integraler Bestandteil der Extract-, Transform-, Load-Prozesse (ETL), die eine effiziente Datenverarbeitung über verteilte Umgebungen hinweg sicherstellen. Pipelines werden von Adaptern ausgeführt, die entweder am Edge (nahe an den Datenquellen) oder zentral in der Cloud bereitgestellt werden können.

OctoMesh verwendet Communication Operators, um verteilte Rechenressourcen mithilfe von Kubernetes zu verwalten. Die Communication Operators sind für die Verwaltung des Lebenszyklus der Workloads eines Deployment Sites verantwortlich — Adapter (Plugs und Sockets) und Applications (containerisierte Geschäftsanwendungen) — einschließlich deren Erstellung, Aktualisierung und Löschung. Jeder Workload wird über helm upgrade --install aus einem Helm-Chart bereitgestellt; siehe Communication Operator für Details.

Warum Pipelines eine Identität haben

Pipeline-Trigger werden verwendet, um die Ausführung einer Pipeline anhand eines Cron-Zeitplans über den Bot Service zu starten.

ck-language-2}

Bei OctoMesh verstehen wir, dass Daten das Herzstück Ihres Betriebs sind. Dieses Kapitel behandelt, wie Sie über unsere Construction Kits (CK) auf Ihre Daten zugreifen und mit ihnen interagieren können – zugeschnitten sowohl auf Runtime-Daten als auch auf Streamdaten (Zeitreihen). Durch die Nutzung von GraphQL-Endpunkten bietet OctoMesh eine nahtlose und effiziente Möglichkeit, mit Ihren Daten zu arbeiten, unabhängig von deren Beschaffenheit.

Streamdaten bieten Zugriff auf Zeitreihendaten, die in CrateDB gespeichert sind. Während Runtime-Abfragen den aktuellen Zustand von Entitäten aus MongoDB abrufen, rufen Streamdaten-Abfragen historische Messwerte und Ereignisse ab, die über die Zeit aufgezeichnet wurden – etwa Sensormesswerte, Maschinenkennzahlen oder Werte der Energieerzeugung.

Der OctoMesh Identity Service stellt zentralisierte Authentifizierung und Autorisierung für die gesamte Plattform bereit. Er unterstützt die Protokolle OAuth 2.0 und OpenID Connect.

Dieses Dokument bietet einen umfassenden Überblick über die Architektur der OctoMesh-Plattform und soll Entwicklern helfen, die Systemkomponenten, Datenflüsse und Integrationsmuster zu verstehen.

Entfernt das Deployment eines bestimmten Datenflusses.

Undeploys a deployment site through the Communication Operator. Undeploy the deployment site's workloads first (UndeployWorkload); Cloud deployment sites release their operator resources.

Entfernt das Deployment aller Trigger für den aktuellen Tenant.

Entfernt das Deployment eines Workloads (Adapter oder Application) über seinen übergeordneten Pool. Destruktiv — der Operator entfernt den Chart per helm-uninstall.

Setzt FrozenUntil auf einem CkRollupArchive zurück. Idempotent. Übergeben Sie --acceptGaps, wenn Quelldaten innerhalb des zuvor eingefrorenen Bereichs abgeschnitten wurden und die daraus resultierenden Lücken akzeptabel sind.

Entfernt ein Blueprint vom aktiven Tenant; mit --cascade werden auch abhängige Blueprints und verwaiste Abhängigkeiten entfernt.

Entfernt einen einzelnen Client-Mirror (verwirft den Client auf der Child-Seite + die Tracking-Zeile des Parents).

Aktualisiert eine API-Ressource.

Aktualisiert einen API-Scope.

Aktualisiert ein API-Secret für eine API-Ressource.

Aktualisiert ein API-Secret für einen Client.

Wendet ein Blueprint-Update auf den aktiven Tenant an.

Aktualisiert einen vorhandenen Client.

Ersetzt die direkt zugewiesenen Rollen eines Clients (Replace-all)

Ändert die Formel einer vorhandenen berechneten Spalte auf einem aktiven Archiv. Leser behalten die bisherigen Werte, während die neue Formel per Backfill nachgefüllt wird, und wechseln dann atomar. Wird abgelehnt, wenn eine andere berechnete Spalte diese referenziert. (AB#4189)

Aktualisiert eine E-Mail-Domain-Gruppenregel.

Aktualisiert ein External-Tenant-User-Mapping.

Aktualisiert eine Gruppe.

Aktualisiert die einer Gruppe zugewiesenen Rollen.

Aktualisiert einen Identity Provider.

Aktualisiert eine Rolle

Aktualisiert das System-Construction-Kit-Modell eines Tenants auf die neueste Version.

Aktualisiert einen Benutzer

Setzt ChartVersion für einen einzelnen Workload. Löst KEIN Deployment aus — rufen Sie anschließend bei Bedarf DeployWorkload auf.

Upgrade einer OctoMesh-Installation von r3.4.x auf r3.5.0 - Backup, geordneter Rollout, Datenmigration auf System.Communication 4.x, Operatoren, Adapter, Blueprints und Rollback.

Wechselt den aktiven Kontext.

CK-Modellversionen folgen SemVer, und Abhängigkeiten werden als Versionsbereiche deklariert – aber welche konkrete Version ein Bereich auflöst, hängt davon ab, wo die Auflösung stattfindet. Dies falsch zu machen ist die häufigste Ursache für ResolveFailed-Modelle und fehlgeschlagene Blueprint-Installationen, weshalb die Regeln hier an einer Stelle ausbuchstabiert werden.

OctoMesh wird in der Produktion mit Kubernetes betrieben. Diese Anleitung führt dasselbe Helm-Chart-Deployment auf einem lokalen kind-Cluster (Kubernetes in Docker) aus.

Das Wartungs-Dashboard ermöglicht Einblicke in Kosten und Wartungsaktivitäten. Es bietet einen umfassenden Überblick über den Wartungsstatus der Assets und die mit den Wartungsaktivitäten verbundenen Kosten. Das Dashboard ist darauf ausgelegt, Wartungsmanager und Techniker dabei zu unterstützen, die Wartungsaktivitäten zu überwachen, die Kosten zu verfolgen und potenzielle Probleme zu identifizieren, die sofortige Aufmerksamkeit erfordern.

access-modifiers}