Skip to content

Commit

Permalink
Prepare repository for Tenzir v4.0.0-rc11 (#3407)
Browse files Browse the repository at this point in the history
This commit is was created with /scripts/prepare-release.

Here is a high-level summary of the changes:

* Updated `/version.json` to v4.0.0-rc11 and the expected rev-count of
the merge commit to 17724.
* Generated a new entry in the docs version selector list.
* Removed the docs for the previous release candidate.
* Moved all changelog entries from `/changelog/v4.0.0-rc10` to
`/changelog/v4.0.0-rc11`.
* Updated the python bindings version in `/python/pyproject.toml` to
v4.0.0-rc11.
  • Loading branch information
tobim committed Jul 27, 2023
2 parents f01e3e6 + dcd8d93 commit 8d6d384
Show file tree
Hide file tree
Showing 228 changed files with 182 additions and 4 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion python/pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "pytenzir"
version = "4.0.0-rc10"
version = "4.0.0-rc11"
description = "A security telemetry engine for detection and response"
authors = ["Tenzir <engineering@tenzir.com>"]
maintainers = ["Tenzir <engineering@tenzir.com>"]
Expand Down
4 changes: 2 additions & 2 deletions version.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@
"annotated git tag without the leading 'v'.",
"This value gets updated automatically by `scripts/prepare-release`."
],
"tenzir-version-fallback": "4.0.0-rc10",
"tenzir-version-fallback": "4.0.0-rc11",
"tenzir-version-rev-count_COMMENT": [
"This value stores the ancestor count of the tagged commit, calculated",
"with `git rev-list --count HEAD`, then incremented by 1. This operates",
"under the assumption that the release-preparing PR contains exactly one",
"commit and is rebased before merging."
],
"tenzir-version-rev-count": 17702,
"tenzir-version-rev-count": 17726,
"tenzir-partition-version_COMMENT": [
"The partition version. This number must be bumped alongside the release",
"version for releases that contain major format changes to the on-disk",
Expand Down
174 changes: 174 additions & 0 deletions web/versioned_docs/version-Tenzir v4.0-rc11/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,174 @@
# Glossary

<!--
This glossary adheres to the following template for defining terms:
## TERM
Brief definition without using TERM.
One additional paragraphs that provide additional information to
understand TERM to its full extent. High-level only to understand the
concept, without going into details, which should be links below this
paragraph.
- Link to relevant material
- Other link to more information
- ...
This convention is not enforced technically.
-->

This page defines central terms in the Tenzir ecosystem.

:::note missing term?
If you are missing a term, please open a [GitHub Discussion][new-discussion] or
ping us in our [Discord chat](/discord).
:::

[new-discussion]: https://github.com/orgs/tenzir/discussions/new?category=questions-answers

## App

Web user interface to access [platform](#platform) at
[app.tenzir.com](https://app.tenzir.com).

The app is a web application that partially runs in the user's browser. It is
written in [Svelte](https://svelte.dev/).

- [Use the app](./setup-guides/use-the-app/README.md)

## Catalog

Maintains [partition](#partition) ownership and metadata.

The catalog is a component in the [node](#node) that owns the
[partitions](#partition), keeps metadata about them, and maintains a set of
sparse secondary indexes to identify relevant partitions for a given query. It
offers a transactional interface for adding and removing partitions.

- [Tune catalog
fragmentation](./setup-guides/tune-performance/README.md#tune-catalog-fragmentation)
- [Configure catalog and partition indexes](./setup-guides/tune-performance/README.md#configure-catalog-and-partition-indexes)

## Connector

Manages chunks of raw bytes by interacting with a resource.

A connector is either a *loader* that acquires bytes from a resource, or a
*saver* that sends bytes to a resource. Example connectors are
[`file`](./connectors/file.md), [`kafka`](./connectors/kafka.md), and
[`nic`](./connectors/nic.md).

- See all available [connectors](./connectors.md)

## Format

Translates between bytes and events.

A format is either a *parser* that converts bytes to events, or a *printer*
that converts events to bytes. Example formats are [`json`](./formats/json.md),
[`cef`](./formats/cef), and [`pcap`](./formats/pcap.md).

- See all available [formats](./formats.md)

## Index

Optional data structures for accelerating historical queries.

Tenzir has *sparse* and *dense* indexes. Sparse indexes live in memory and point
to [partitions](#partition), whereas dense indexes live within a partition and
point to individual rows within the partition.

- [Configure catalog and partition indexes](./setup-guides/tune-performance/README.md#configure-catalog-and-partition-indexes)

## Node

A host for [pipelines](#pipeline) and storage reachable over the network.

The `tenzir-node` binary starts a node in a dedicated server process that
listens on TCP port 5158.

- [Deploy a node](./setup-guides/deploy-a-node/README.md)
- [Use the app](./setup-guides/use-the-app/README.md) to manage a node
- Use the [REST API](./rest-api.md) to manage a node
- [Import into a node](./user-guides/import-into-a-node.md)
- [Export from a node](./user-guides/export-from-a-node.md)

## Metrics

Runtime statistics about pipeline execution.

- [Collect metrics](./setup-guides/collect-metrics.md)

## Operator

The building block of a [pipeline](#pipeline).

An operator is a [source](#source), [transformation](#transformation), or
[sink](#sink).

- See all available [operators](./operators.md)

## Partition

The horizontal scaling unit of the storage attached to a [node](#node).

A partition contains the raw data and optionally a set of indexes. Supported
formats are [Parquet](https://parquet.apache.org) or
[Feather](https://arrow.apache.org/docs/python/feather.html).

- [Control the partition size](./setup-guides/tune-performance/README.md#control-the-partition-size)
- [Configure catalog and partition indexes](./setup-guides/tune-performance/README.md#configure-catalog-and-partition-indexes)
- [Select the store format](./setup-guides/tune-performance/README.md#select-the-store-format)
- [Adjust the store
compression](./setup-guides/tune-performance/README.md#adjust-the-store-compression)
- [Rebuild partitions](./setup-guides/tune-performance/README.md#rebuild-partitions)

## Pipeline

Combines a set of [operators](#operator) into a dataflow graph.

- Understand the [pipeline language](./language/pipelines.md)
- [Run a pipeline](./user-guides/run-a-pipeline/README.md)

## Platform

Control plane for nodes and pipelines, accessible through [app](#app) at
[app.tenzir.com](https://app.tenzir.com).

- [Use the app](./setup-guides/use-the-app/README.md)

## Schema

A named record type describing the top-level structure of a data frame.

[Schemas](./data-model/schemas.md)

- [Show available schemas](./user-guides/show-available-schemas.md)

## Sink

An [operator](#operator) consuming input, without producing any output.

- See all available [sinks](./operators/sinks/README.md)

## Source

An [operator](#operator) producing output, without consuming any input.

- See all available [sources](./operators/sources/README.md)

## TQL

An acronym for *Tenzir Query Language*.

TQL is the language in which users write [pipelines](#pipeline).

- Learn more about the [language](./language/pipelines.md)

## Transformation

An [operator](#operator) consuming both input and producing output.

- See all [transformations](./operators/transformations/README.md)
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,10 @@
"type": "doc",
"id": "configuration"
},
{
"type": "doc",
"id": "glossary"
},
{
"type": "html",
"value": "<br><b>Developers<b/>"
Expand Down
2 changes: 1 addition & 1 deletion web/versions.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[
"Tenzir v4.0-rc10",
"Tenzir v4.0-rc11",
"VAST v3.1",
"VAST v3.0"
]

0 comments on commit 8d6d384

Please sign in to comment.