Skip to content

Commit 6fd4fa5

Browse files
authored
New navigation model and docs refactoring (#321)
* Update sidebars.js * [sidebar] add labels for builtin integration, avoid showing ext stream or table * delete kafka-source and its reference * enable docusaurus v4 features, change logo to 160x32 * mount external-stream page * Delete getting-started.md * remove stream-generator and workspace * remove install.md and its references * merge proton-create-view.md and view.md * Delete proton-create-stream * Delete integration-metabase.md * Delete issues.md * big change of the nav tree * WIP new nav model * create new folder for stream processing * WIP faq for TPE and Proton and compare page * update glossary * combine/clean up files, also add missing.js to check unmounted md * big update to showcases * update proton vs TPE doc, refine faq and howto * Create list-pages.ts * Update list-pages.ts * finish TODO and move mv page up * fix typo and update dic.txt * Update sidebars.js * hide credits * combine 2 single node and cluster install to one * add link to random stream * show the title on main page is View and Materialized View
1 parent c422d42 commit 6fd4fa5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

76 files changed

+1502
-1606
lines changed

docs/alert.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,13 @@
22

33
Timeplus provides out-of-box charts and dashboards. You can also create [sinks](/destination) to send downsampled data to Kafka or other message buses, or notify others via email/slack. You can even send new messages to Kafka, then consume such messages timely in the downstream system. This could be a solution for alerting and automation.
44

5-
Since it's a common use case to define and manage alerts, Timeplus started supporting alerts out-of-box.
5+
Since it's a common use case to define and manage alerts, Timeplus supports alerting out-of-box.\
6+
7+
:::warning
8+
Starting from Timeplus Enterprise v2.9, the alerting feature will be provided by the core SQL engine, with increased performance and stability, as well as SQL based manageability.
9+
10+
The previous alerting feature will be deprecated in the future releases.
11+
:::
612

713
## Create New Alert Rule
814

docs/append-stream.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Append Stream
2+
3+
By default, the streams in Timeplus are Append Streams:
4+
* They are designed to handle a continuous flow of data, where new events are added to the end of the stream.
5+
* The data is saved in columnar storage, optimized for high throughput and low latency read and write.
6+
* Older data can be purged automatically by setting a retention policy, which helps manage storage costs and keeps the stream size manageable.
7+
* Limited capabilities to update or delete existing data, as the primary focus is on appending new data.

docs/proton-architecture.md renamed to docs/architecture.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## High Level Architecture
44

5-
The following diagram depicts the high level architecture of Proton.
5+
The following diagram depicts the high level architecture of Timeplus SQL engine, starting from a single node deployment.
66

7-
![Proton Architecture](/img/proton-high-level-arch.gif)
7+
![Architecture](/img/proton-high-level-arch.gif)
88

99
All of the components / functionalities are built into one single binary.
1010

1111
## Data Storage
1212

13-
Users can create a stream by using `CREATE STREAM ...` [DDL SQL](/proton-create-stream). Every stream has 2 parts at storage layer by default:
13+
Users can create a stream by using `CREATE STREAM ...` [DDL SQL](/sql-create-stream). Every stream has 2 parts at storage layer by default:
1414

1515
1. the real-time streaming data part, backed by Timeplus NativeLog
1616
2. the historical data part, backed by ClickHouse historical data store.

docs/singlenode_install.md renamed to docs/bare-metal-install.md

Lines changed: 54 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
1-
# Single Node Install
1+
# Deploy on Bare Metal
22

3-
Timeplus Enterprise can be easily installed on a single node, with or without Docker.
3+
Timeplus Enterprise can be easily installed bare metal Linux or MacOS, as a single node or multi-node clsuter.
44

5-
## Bare Metal Install{#bare_metal}
5+
## Single Node Install
66

77
### Install Script
88

9-
If your server or computer is running Linux or MacOS, you can run the following command to download the package and start Timeplus Enterprise without any other dependencies. For Windows users, please follow [our guide](#docker) for running Timeplus Enterprise with Docker.
9+
If your server or computer is running Linux or MacOS, you can run the following command to download the package and start Timeplus Enterprise without any other dependencies.
10+
:::info
11+
For Windows users, please follow [our guide](#docker) for running Timeplus Enterprise with Docker.
12+
:::
1013

1114
```shell
1215
curl https://install.timeplus.com | sh
@@ -17,8 +20,9 @@ This script will download the latest release (based on your operating system and
1720
If you'd like to download the package for a certain feature release, you can run the following command:
1821

1922
```shell
20-
curl https://install.timeplus.com/2.7 | sh
23+
curl https://install.timeplus.com/2.8 | sh
2124
```
25+
Replace `2.8` with the desired version number.
2226

2327
### Manual Install
2428
You can also download packages manually with the following links:
@@ -50,6 +54,12 @@ It is also possible to only start/stop single process by running `timeplus start
5054

5155
For more information, please check the [CLI Reference](/cli-reference).
5256

57+
### Upgrade {#upgrade}
58+
To upgrade Timeplus Enterprise, run `timeplus stop` to stop all the services. Then replace all the binaries to the higher version of Timeplus Enterprise release and then run `timeplus start`.
59+
60+
### Uninstall {#uninstall}
61+
Timeplus Enterprise has no external dependencies. Just run `timeplus stop` then delete the timeplus folder.
62+
5363
## Docker Install{#docker}
5464

5565
Alternatively, run the following command to start Timeplus Enterprise with [Docker](https://www.docker.com/get-started/):
@@ -79,13 +89,46 @@ This stack demonstrates how to run streaming ETL, getting data from Kafka API, a
7989
* [Tutorial – Streaming ETL: Kafka to Kafka](/tutorial-sql-etl)
8090
* [Tutorial – Streaming ETL: Kafka to ClickHouse](/tutorial-sql-etl-kafka-to-ch)
8191

92+
## Cluster Install
93+
Timeplus Enterprise can be installed in multi-node cluster mode for high availability and horizontal scalability. This page shares how to install Timeplus cluster on bare metal. Pleae refer to [this guide](/k8s-helm) to deploy Timeplus Enterprise on Kubernetes.
94+
95+
### Multi-Node Cluster
96+
97+
There are multiple ways to setup a cluster without Kubernetes. One easy solution is to run all components in one node, and the rest of nodes running the timeplusd only. For other deployment options, please contact [support](mailto:support@timeplus.com) or message us in our [Slack Community](https://timeplus.com/slack).
98+
99+
Choose one node as the lead node, say its hostname is `timeplus-server1`. Stop all services via `timeplus stop` command. Then configure environment variables.
100+
```bash
101+
export ADVERTISED_HOST=timeplus-server1
102+
export METADATA_NODE_QUORUM=timeplus-server1:8464,timeplus-server2:8464,timeplus-server3:8464
103+
export TIMEPLUSD_REPLICAS=3
104+
```
105+
Then run `timeplus start` to start all services, including timeplusd, timeplus_web, timeplus_appserver and timeplus_connector.
106+
107+
On the second node, first make sure all services are stopped via `timeplus stop`.
108+
Then configure environment variables.
109+
```bash
110+
export ADVERTISED_HOST=timeplus-server2
111+
export METADATA_NODE_QUORUM=timeplus-server1:8464,timeplus-server2:8464,timeplus-server3:8464
112+
```
113+
Then run `timeplus start -s timeplusd` to only start timeplusd services.
114+
115+
Similarly on the third node, set `export ADVERTISED_HOST=timeplus-server3` and the same `METADATA_NODE_QUORUM` and only start timeplusd.
116+
117+
### Single-Host Cluster {#single-host-cluster}
118+
119+
Starting from [Timeplus Enterprise v2.7](/enterprise-v2.7), you can also easily setup multiple timeplusd processes on the same host by running the `timeplusd server` with `node-index` option. This is useful for testing multi-node cluster.
120+
```bash
121+
./timeplusd server --node-index=1
122+
./timeplusd server --node-index=2
123+
./timeplusd server --node-index=3
124+
```
125+
126+
Timeplusd will automatically bind to different ports for each node. You can run `timeplusd client` to connect to one node and check the status of the cluster via:
127+
```sql
128+
SELECT * FROM system.cluster
129+
```
130+
82131
## License Management{#license}
83132
When you start Timeplus Enterprise and access the web console for the first time, the 30-day free trial starts. When it ends, the software stops working.
84133

85134
Please check [the guide](/server_config#license) to update licenses.
86-
87-
## Upgrade {#upgrade}
88-
To upgrade Timeplus Enterprise, run `timeplus stop` to stop all the services. Then replace all the binaries to the higher version of Timeplus Enterprise release and then run `timeplus start`.
89-
90-
## Uninstall {#uninstall}
91-
Timeplus Enterprise has no external dependencies. Just run `timeplus stop` then delete the timeplus folder.

docs/changelog-stream.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Changelog Stream
1+
# Changelog Key Value Stream
22

33
When you create a stream with the mode `changelog_kv`, the data in the stream is no longer append-only. When you query the stream directly, only the latest version for the same primary key(s) will be shown. Data can be updated or deleted. You can use Changelog Stream in JOIN either on the left or on the right. Timeplus will automatically choose the latest version.
44

@@ -17,7 +17,7 @@ In this example, you create a stream `dim_products` in `changelog_kv` mode with
1717

1818
:::info
1919

20-
The rest of this page assumes you are using Timeplus Console. If you are using Proton, you can create the stream with DDL. [Learn more](/proton-create-stream#changelog-stream)
20+
The rest of this page assumes you are using Timeplus Console. If you are using Proton, you can create the stream with DDL.
2121

2222
:::
2323

@@ -403,7 +403,7 @@ Debezium also read all existing rows and generate messages like this
403403

404404
### Load data to Timeplus
405405

406-
You can follow this [guide](/kafka-source) to add 2 data sources to load data from Kafka or Redpanda. For example:
406+
You can follow this [guide](/proton-kafka) to add 2 external streams to load data from Kafka or Redpanda. For example:
407407

408408
* Data source name `s1` to load data from topic `doc.public.dim_products` and put in a new stream `rawcdc_dim_products`
409409
* Data source name `s2` to load data from topic `doc.public.orders` and put in a new stream `rawcdc_orders`

docs/cluster_install.md

Lines changed: 0 additions & 61 deletions
This file was deleted.

docs/compare.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Timeplus Proton vs. Timeplus Enterprise
2+
3+
Timeplus Proton powers unified streaming and data processing on a single database node. Its commercial counterpart, Timeplus Enterprise, supports advanced deployment strategy and includes enterprise-ready features.
4+
5+
| Features | **Timeplus Proton** | **Timeplus Enterprise** |
6+
| ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7+
| **Deployment** | <ul><li>Single-node Docker image</li><li>Single binary on Mac/Linux</li></ul> | <ul><li>Single node</li><li>Multi-node Cluster for high availability and horizontal scalability, with data replication and distributed query processing</li><li>[Kubernetes Helm Chart](/k8s-helm)</li></ul> |
8+
| **Data Processing** | <ul><li>[Streaming SQL](/stream-query)</li><li>[Historical Data Processing](/history)</li><li>[Append Stream](/append-stream), Random streams, Mutable Stream v1 ([Versioned Stream](/versioned-stream))</li><li>Streaming transformation, [join](/joins), [aggregation](/streaming-aggregations), [tumble/hop/session windows](/streaming-windows)</li><li>User-Defined Function: [JavaScript](/js-udf), [Remote](/remote-udf), [SQL](/sql-udf)</li></ul> | <ul><li>Everything in Timeplus Proton</li><li>Auto-scaling Materialized View</li><li>[Mutable Stream v2](/mutable-stream) with row-based storage for 3x performance and efficiency, also support coalesced and better high cardinality data mutations</li><li>Support more [EMIT](/streaming-aggregations#emit) strategies and spill-to-disk capabilities when memory is scarce</li><li>[Python UDF](/py-udf)</li><li>[Dynamic Dictionary](/sql-create-dictionary) based on MySQL/Postgres or Mutable streams</li><li>[Tiered Storage](/tiered-storage) using S3 or HDD</li><li>[Just-In-Time compilation](/jit)</li></ul> |
9+
| **External Systems** | <ul><li>External streams to [Apache Kafka, Confluent Cloud, Redpanda](/proton-kafka), [Apache Pulsar](/pulsar-external-stream), and [Remote Timeplus](/timeplus-external-stream)</li><li>[Streaming ingestion via REST API (compact mode only)](/proton-ingest-api)</li><li>[External table to ClickHouse](/proton-clickhouse-external-table)</li></ul> | <ul><li>Everything in Timeplus Proton</li><li>External streams to [HTTP API](/http-external), External tables to [MySQL](/mysql-external-table), [PostgreSQL](/pg-external-table), [MongoDB](/mongo-external), [Amazon S3](/s3-external), [Apache Iceberg](/iceberg) </li><li>Hundreds of connectors from [Redpanda Connect](/redpanda-connect), e.g. WebSocket, HTTP Stream, NATS</li><li>CSV upload</li><li>[Streaming ingestion via REST API (with API key and flexible modes)](/ingest-api)</li></ul> |
10+
| **Web Console** | | <ul><li>[RBAC](/rbac), Pipeline Wizard, SQL Exploration, Data Lineage, Cluster Monitoring, Troubleshooting and Manageability</li></ul> |
11+
| **Support** | <ul><li>Community support from GitHub and Slack</li></ul> | <ul><li>Enterprise support via email, Slack, and Zoom, with a SLA</li></ul> |
12+
13+
These details are subject to change, but we'll do our best to make sure they accurately represent the latest roadmaps for Timeplus Proton and Timeplus Enterprise.
14+
15+
[Contact us](mailto:info@timeplus.com) for more details or schedule a demo.

docs/confluent-cloud-source.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/enterprise-releases.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

0 commit comments

Comments
 (0)