Skip to content

Commit

Permalink
Add two more setup guides
Browse files Browse the repository at this point in the history
  • Loading branch information
mavam committed Mar 1, 2025
1 parent 2f8c53a commit a28a4f0
Show file tree
Hide file tree
Showing 4 changed files with 112 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ can find a preview of the new documentation at

- [x] Hoist SVGs and apply auto-darkmode
- [x] TQL syntax highlighting
- [ ] Fixing sizing calculator iframe height (CSS?)
- [ ] Fix github-{light,dark} syntax theme selection
- [ ] Do CSS magic to fuse subsequent TQL code blocks
- [ ] Apply Tailwind CSS and get a facelift
Expand Down
31 changes: 31 additions & 0 deletions src/content/docs/guides/setup/create-an-account.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@

---
title: Create an account
---

If you want to manage your nodes via the platform through our app, you must
create an account.

Creating an account is free and takes just two steps:

1. Go to [app.tenzir.com](https://app.tenzir.com)
2. Sign in with your identity provider

Congratulations, you now have an account and can can freely use the
[Community Edition](https://tenzir.com/pricing).

## Delete an Account

Delete your account as follows:

1. Go to the [Account](https://app.tenzir.com/account) page.
2. Click *Delete Account*.
3. (Optionally) Leave a note explaining why you delete your account.

:::caution
Deleting your account will remove all data about you from our cloud platform.
You will also lose the ability to manage pipelines on your node.
:::

If you decide to come back, just re-create an account as described
above.
77 changes: 77 additions & 0 deletions src/content/docs/guides/setup/size-a-node.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@

---
title: Size a node
---

To better understand what resources you need to [run a
node](../installation/deploy-a-node/README.md), we provide guidance on sizing
and a [calculator](#calculator) to derive concrete **CPU**, **RAM**, and
**storage** requirements.

## Considerations

Several factors have an impact on sizing. Since you can run many types of
workloads in pipelines, it is difficult to make a one-size-fits-all
recommendation. The following considerations affect your resource requirements:

### Workloads

Depending on what you do with pipelines, you may generate a different resource
profile.

#### Data Shaping

[Shaping](../usage/shape-data/README.md) operation changes the form of the
data, e.g., filtering events, removing columns, or changing values. This
workload predominantly incurs **CPU** load.

#### Aggregation

Performing in-stream or historical aggregations often requires extensive
buffering of the aggregation groups, which adds to your **RAM** requirements. If
you run intricate custom aggregation functions, you also may see an additional
increase CPU usage.

#### Enrichment

[Enriching](../enrichment/README.md) dataflows with contexts requires holding
in-memory state proportional to the context size. Therefore, enrichment affects
your **RAM** requirements. Bloom filters are a fixed-size space-efficient
structure for representing large sets, and lookup tables grow linearly with the
number of entries.

### Data Diversity

The more data sources you have, the more pipelines you run. In the simplest
scenario where you just [import all data into a
node](../usage/import-into-a-node/README.md), you deploy one pipeline per
data source. The number of data sources is a thus a lower bound for the number
of pipelines.

### Data Volume

The throughput of pipeline has an impact on performance. Pipelines with low data
volume do not strain the system much, but high-volume pipelines substantially
affect **CPU** and **RAM** requirements. Therefore, understanding your ingress
volume, either as events per second or bytes per day, is helpful for sizing your
node proportionally.

### Retention

When you leverage the node's built-in storage engine by
[importing](../usage/import-into-a-node/README.md) and
[exporting](../usage/export-from-a-node/README.md) data, you need
persistent **storage**. To assess your retention span, you need to understand
your data volume and your capacity.

Tenzir storage engine builds sparse indexes to accelerate historical queries.
Based on how aggressively configure indexing, your **RAM** requirements may
vary.

## Calculator

<iframe
src="https://tenzir-node-sizing.streamlit.app/?embed=true"
height="1300"
style={{ width: "100%", border: "none" }}
></iframe>
4 changes: 3 additions & 1 deletion src/sidebar.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ export const sidebar = [
{
label: 'Setup',
items: [
'guides/setup/start-the-node-api'
'guides/setup/create-an-account',
'guides/setup/size-a-node',
'guides/setup/start-the-node-api',
],
},
],
Expand Down

0 comments on commit a28a4f0

Please sign in to comment.