Reduce visibility of Tranquility documentation (#11134)

* reduce visibility of tranquility doc

Co-authored-by: Charles Smith <38529548+techdocsmith@users.noreply.github.com>
This commit is contained in:
sthetland 2021-05-03 16:48:24 -07:00 committed by GitHub
parent 84aac4832d
commit ca1412d574
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
7 changed files with 31 additions and 29 deletions

View File

@ -235,9 +235,6 @@ transaction.
metadata in a single transaction after the subtasks are finished. In simple (single-task) mode, the single task metadata in a single transaction after the subtasks are finished. In simple (single-task) mode, the single task
publishes all segment metadata in a single transaction after it is complete. publishes all segment metadata in a single transaction after it is complete.
[Tranquility](../ingestion/tranquility.md), a streaming ingestion method that is no longer recommended, does not perform
transactional loading.
Additionally, some ingestion methods offer an _idempotency_ guarantee. This means that repeated executions of the same Additionally, some ingestion methods offer an _idempotency_ guarantee. This means that repeated executions of the same
ingestion will not cause duplicate data to be ingested: ingestion will not cause duplicate data to be ingested:

View File

@ -22,19 +22,18 @@ title: "Ingestion"
~ under the License. ~ under the License.
--> -->
## Overview All data in Druid is organized into _segments_, which are data files each of which may have up to a few million rows.
Loading data in Druid is called _ingestion_ or _indexing_, and consists of reading data from a source system and creating
All data in Druid is organized into _segments_, which are data files that generally have up to a few million rows each.
Loading data in Druid is called _ingestion_ or _indexing_ and consists of reading data from a source system and creating
segments based on that data. segments based on that data.
In most ingestion methods, the work of loading data is done by Druid [MiddleManager](../design/middlemanager.md) processes In most ingestion methods, the Druid [MiddleManager](../design/middlemanager.md) processes
(or the [Indexer](../design/indexer.md) processes). One exception is (or the [Indexer](../design/indexer.md) processes) load your source data. One exception is
Hadoop-based ingestion, where this work is instead done using a Hadoop MapReduce job on YARN (although MiddleManager or Indexer Hadoop-based ingestion, where this work is instead done using a Hadoop MapReduce job on YARN (although MiddleManager or Indexer
processes are still involved in starting and monitoring the Hadoop jobs). Once segments have been generated and stored processes are still involved in starting and monitoring the Hadoop jobs).
in [deep storage](../dependencies/deep-storage.md), they will be loaded by Historical processes. For more details on
how this works under the hood, see the [Storage design](../design/architecture.md#storage-design) section of Druid's design Once segments have been generated and stored in [deep storage](../dependencies/deep-storage.md), they are loaded by Historical processes.
documentation. For more details on how this works, see the [Storage design](../design/architecture.md#storage-design) section
of Druid's design documentation.
## How to use this documentation ## How to use this documentation
@ -57,17 +56,17 @@ page.
### Streaming ### Streaming
The most recommended, and most popular, method of streaming ingestion is the The most recommended, and most popular, method of streaming ingestion is the
[Kafka indexing service](../development/extensions-core/kafka-ingestion.md) that reads directly from Kafka. The Kinesis [Kafka indexing service](../development/extensions-core/kafka-ingestion.md) that reads directly from Kafka. Alternatively, the Kinesis
indexing service also works well if you prefer Kinesis. indexing service works with Amazon Kinesis Data Streams.
This table compares the major available options: This table compares the options:
| **Method** | [Kafka](../development/extensions-core/kafka-ingestion.md) | [Kinesis](../development/extensions-core/kinesis-ingestion.md) | [Tranquility](tranquility.md) | | **Method** | [Kafka](../development/extensions-core/kafka-ingestion.md) | [Kinesis](../development/extensions-core/kinesis-ingestion.md) |
|---|-----|--------------|------------| |---|-----|--------------|
| **Supervisor type** | `kafka` | `kinesis` | N/A | | **Supervisor type** | `kafka` | `kinesis`|
| **How it works** | Druid reads directly from Apache Kafka. | Druid reads directly from Amazon Kinesis. | Tranquility, a library that ships separately from Druid, is used to push data into Druid. | | **How it works** | Druid reads directly from Apache Kafka. | Druid reads directly from Amazon Kinesis.|
| **Can ingest late data?** | Yes | Yes | No (late data is dropped based on the `windowPeriod` config) | | **Can ingest late data?** | Yes | Yes |
| **Exactly-once guarantees?** | Yes | Yes | No | | **Exactly-once guarantees?** | Yes | Yes |
### Batch ### Batch

View File

@ -1,4 +1,5 @@
--- ---
id: standalone-realtime
layout: doc_page layout: doc_page
title: "Realtime Process" title: "Realtime Process"
--- ---

View File

@ -294,7 +294,7 @@ Once `forceTimeChunkLock` is unset, the task will choose a proper lock type to u
Please note that segment lock is not always available. The most common use case where time chunk lock is enforced is Please note that segment lock is not always available. The most common use case where time chunk lock is enforced is
when an overwriting task changes the segment granularity. when an overwriting task changes the segment granularity.
Also, the segment locking is supported by only native indexing tasks and Kafka/Kinesis indexing tasks. Also, the segment locking is supported by only native indexing tasks and Kafka/Kinesis indexing tasks.
Hadoop indexing tasks and `index_realtime` tasks (used by [Tranquility](tranquility.md)) don't support it yet. Hadoop indexing tasks don't support it.
`forceTimeChunkLock` in the task context is only applied to individual tasks. `forceTimeChunkLock` in the task context is only applied to individual tasks.
If you want to unset it for all tasks, you would want to set `druid.indexer.tasklock.forceTimeChunkLock` to false in the [overlord configuration](../configuration/index.md#overlord-operations). If you want to unset it for all tasks, you would want to set `druid.indexer.tasklock.forceTimeChunkLock` to false in the [overlord configuration](../configuration/index.md#overlord-operations).
@ -384,7 +384,7 @@ Submitted automatically, on your behalf, by a
### `index_realtime` ### `index_realtime`
Submitted automatically, on your behalf, by [Tranquility](tranquility.md). Submitted automatically, on your behalf, by [Tranquility](tranquility.md).
### `compact` ### `compact`

View File

@ -22,11 +22,11 @@ title: "Tranquility"
~ under the License. ~ under the License.
--> -->
[Tranquility](https://github.com/druid-io/tranquility/) is a package for pushing [Tranquility](https://github.com/druid-io/tranquility/) is a separately distributed package for pushing
streams to Druid in real-time. Druid does not come bundled with Tranquility; it is available as a separate download. streams to Druid in real-time.
Note that as of this writing, the latest available version of Tranquility is built against the rather old Druid 0.9.2 Tranquility has not been built against a version of Druid later than Druid 0.9.2
release. It will still work with the latest Druid servers, but not all features and functionality will be available release. It may still work with the latest Druid servers, but not all features and functionality will be available
due to limitations of older Druid APIs on the Tranquility side. due to limitations of older Druid APIs on the Tranquility side.
For new projects that require streaming ingestion, we recommend using Druid's native support for For new projects that require streaming ingestion, we recommend using Druid's native support for

View File

@ -134,6 +134,9 @@
"development/extensions-contrib/opentsdb-emitter": { "development/extensions-contrib/opentsdb-emitter": {
"title": "OpenTSDB Emitter" "title": "OpenTSDB Emitter"
}, },
"development/extensions-contrib/prometheus": {
"title": "Prometheus Emitter"
},
"development/extensions-contrib/redis-cache": { "development/extensions-contrib/redis-cache": {
"title": "Druid Redis Cache" "title": "Druid Redis Cache"
}, },
@ -501,6 +504,9 @@
"title": "TopN queries", "title": "TopN queries",
"sidebar_label": "TopN" "sidebar_label": "TopN"
}, },
"querying/using-caching": {
"title": "Using query caching"
},
"querying/virtual-columns": { "querying/virtual-columns": {
"title": "Virtual columns" "title": "Virtual columns"
}, },

View File

@ -41,7 +41,6 @@
"ids": [ "ids": [
"development/extensions-core/kafka-ingestion", "development/extensions-core/kafka-ingestion",
"development/extensions-core/kinesis-ingestion", "development/extensions-core/kinesis-ingestion",
"ingestion/tranquility",
"ingestion/standalone-realtime" "ingestion/standalone-realtime"
] ]
}, },