-
-
Notifications
You must be signed in to change notification settings - Fork 3
Add Platform Data Flow explanation page #319
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lava
wants to merge
4
commits into
main
Choose a base branch
from
claude/document-node-platform-data-gUBh5
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+102
−0
Open
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| --- | ||
| title: Platform Data Flow | ||
| --- | ||
|
|
||
| When a [node](/explanations/node) starts, it opens a single outbound, | ||
| TLS-encrypted WebSocket connection to the [platform](/explanations/platform). | ||
| This page describes what flows over that connection so you can reason about | ||
| privacy, compliance, and what an operator of the platform can see. | ||
|
|
||
| For the bigger picture on TLS termination and trust boundaries, see the | ||
| [FAQ entry on data privacy](/explanations/faqs#can-tenzir-see-my-data). | ||
|
|
||
| ## The connection is a tunnel, not a feed | ||
|
|
||
| The node does not push state to the platform. It opens the WebSocket, | ||
| authenticates, and then waits. The platform — and through it, the app — | ||
| uses this connection as a reverse tunnel to call the | ||
| [node API](/reference/node/api) on demand. | ||
|
|
||
| In other words: whatever the app shows you about a node was pulled from | ||
| that node at the moment you asked for it. The platform does not maintain | ||
| a continuously updated mirror of the node's state. | ||
|
|
||
| The node initiates the connection — the platform never connects to the | ||
| node. For nodes registered with the Tenzir-hosted platform, the endpoint | ||
| defaults to `wss://ws.tenzir.app:443/production`. See | ||
| <Guide>node-setup/configure-tls</Guide> for the TLS options. | ||
|
|
||
| ## What the app pulls on demand | ||
|
|
||
| Anything you can retrieve via the [node API](/reference/node/api), the | ||
| platform can retrieve on behalf of an authenticated user in your | ||
| workspace. In practice this means: | ||
|
|
||
| - The list of **pipelines** on the node, their TQL source, labels, and | ||
| lifecycle state. | ||
| - **Pipeline metrics** such as ingress/egress event and byte counters. | ||
| - **Diagnostics** (warnings and errors) emitted by pipelines. | ||
| - **Contexts** — their names, types, and, if you open them in the app, | ||
| their contents. | ||
| - **Packages** installed on the node and their configuration. | ||
| - **Schemas** the node has seen. | ||
|
|
||
| These are fetched when a page or component in the app needs them. Close | ||
| the page and the requests stop. | ||
|
|
||
| ## Pipeline data does not flow through the platform | ||
|
|
||
| Pipelines run entirely on the node. The events flowing through a | ||
| pipeline's operators are **not** routed through the platform, regardless | ||
| of where the pipeline was created. | ||
|
|
||
| The single exception is a pipeline you run interactively from the app | ||
| (for example, in the Explorer). In that case the results stream | ||
| node → platform → browser for as long as the view is open, so the app | ||
| can render them. They are not persisted on the platform. | ||
|
|
||
| ## Secrets | ||
|
|
||
| When a pipeline accesses a secret, the node requests its value from the | ||
| platform over the same encrypted channel, and the platform replies with | ||
| the resolved value. See <Explanation>secrets</Explanation>. | ||
|
|
||
| ## What is *not* sent | ||
|
|
||
| The platform does **not** receive: | ||
|
|
||
| - The **events stored in the node** (Parquet partitions, the catalog, | ||
| or query results) — unless you explicitly query them from the app. | ||
| - The **raw bytes** ingested from your sources. | ||
| - **Pipeline payloads** for pipelines that aren't being viewed live in | ||
| the app. | ||
| - **Node configuration files**, environment variables, or secret values | ||
| defined locally on the node. | ||
| - **Operating system logs** or anything outside the `tenzir-node` | ||
| process. | ||
|
|
||
| ## Encryption and trust | ||
|
|
||
| The WebSocket is TLS-encrypted and terminates at the platform. In the | ||
| Tenzir-hosted editions, the operator of the platform (Tenzir) is | ||
| therefore technically able to observe data that traverses it during | ||
| interactive use. If this is unacceptable, run the platform yourself | ||
| with the [Sovereign Edition](https://tenzir.com/pricing) — see | ||
| <Guide>platform-setup</Guide>. | ||
|
|
||
| ## See Also | ||
|
|
||
| - <Guide>node-setup/configure-tls</Guide> | ||
| - <Explanation>platform</Explanation> | ||
| - <Explanation>node</Explanation> | ||
| - <Explanation>secrets</Explanation> | ||
| - <Explanation>faqs</Explanation> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.