From 9791a4d12cb65998c9a7991c221a512f0f5ca0ee Mon Sep 17 00:00:00 2001 From: Ginger Collison Date: Mon, 15 Mar 2021 14:58:32 +0000 Subject: [PATCH] GitBook: [master] 14 pages modified --- SUMMARY.md | 12 +----------- jetstream/concepts/streams.md | 2 +- .../README.md => model_deep_dive.md} | 6 +++--- jetstream/model_deep_dive/ack-sampling.md | 2 -- jetstream/model_deep_dive/acknowledgment-models.md | 2 -- jetstream/model_deep_dive/consumer-message-rates.md | 2 -- .../model_deep_dive/consumer-starting-position.md | 2 -- jetstream/model_deep_dive/ephemeral-consumers.md | 2 -- jetstream/model_deep_dive/exactly-once-delivery.md | 2 -- jetstream/model_deep_dive/message-deduplication.md | 2 -- jetstream/model_deep_dive/storage-overhead.md | 2 -- ...ream-limits-retention-modes-and-discard-policy.md | 2 -- jetstream/model_deep_dive/stream-templates.md | 2 -- 13 files changed, 5 insertions(+), 35 deletions(-) rename jetstream/{model_deep_dive/README.md => model_deep_dive.md} (97%) delete mode 100644 jetstream/model_deep_dive/ack-sampling.md delete mode 100644 jetstream/model_deep_dive/acknowledgment-models.md delete mode 100644 jetstream/model_deep_dive/consumer-message-rates.md delete mode 100644 jetstream/model_deep_dive/consumer-starting-position.md delete mode 100644 jetstream/model_deep_dive/ephemeral-consumers.md delete mode 100644 jetstream/model_deep_dive/exactly-once-delivery.md delete mode 100644 jetstream/model_deep_dive/message-deduplication.md delete mode 100644 jetstream/model_deep_dive/storage-overhead.md delete mode 100644 jetstream/model_deep_dive/stream-limits-retention-modes-and-discard-policy.md delete mode 100644 jetstream/model_deep_dive/stream-templates.md diff --git a/SUMMARY.md b/SUMMARY.md index fb3d627..a170656 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -132,17 +132,7 @@ * [GitHub Actions](jetstream/configuration_mgmt/github_actions.md) * [Kubernetes Controller](jetstream/configuration_mgmt/kubernetes_controller.md) * [Disaser Recovery](jetstream/disaster_recovery.md) -* [Model Deep Dive](jetstream/model_deep_dive/README.md) - * [Stream Limits, Retention Modes and Discard Policy](jetstream/model_deep_dive/stream-limits-retention-modes-and-discard-policy.md) - * [Message Deduplication](jetstream/model_deep_dive/message-deduplication.md) - * [Acknowledgment Models](jetstream/model_deep_dive/acknowledgment-models.md) - * [Exactly Once Delivery](jetstream/model_deep_dive/exactly-once-delivery.md) - * [Consumer Starting Position](jetstream/model_deep_dive/consumer-starting-position.md) - * [Ephemeral Consumers](jetstream/model_deep_dive/ephemeral-consumers.md) - * [Consumer Message Rates](jetstream/model_deep_dive/consumer-message-rates.md) - * [Stream Templates](jetstream/model_deep_dive/stream-templates.md) - * [Ack Sampling](jetstream/model_deep_dive/ack-sampling.md) - * [Storage Overhead](jetstream/model_deep_dive/storage-overhead.md) +* [Model Deep Dive](jetstream/model_deep_dive.md) * [NATS API Reference](jetstream/nats_api_reference.md) * [Multi-tenancy & Resource Mgmt](jetstream/resource_management.md) diff --git a/jetstream/concepts/streams.md b/jetstream/concepts/streams.md index 6b31291..fd776d6 100644 --- a/jetstream/concepts/streams.md +++ b/jetstream/concepts/streams.md @@ -10,7 +10,7 @@ Streams can consume many subjects. Here we have `ORDERS.*` but we could also con Streams support various retention policies - they can be kept based on limits like max count, size or age but also more novel methods like keeping them as long as any Consumers have them unacknowledged, or work queue like behavior where a message is removed after first ack. -Streams support deduplication using a `Nats-Msg-Id` header and a sliding window within which to track duplicate messages. See the [Message Deduplication](../model_deep_dive/#message-deduplication) section. +Streams support deduplication using a `Nats-Msg-Id` header and a sliding window within which to track duplicate messages. See the [Message Deduplication](../model_deep_dive.md#message-deduplication) section. When defining Streams the items below make up the entire configuration of the set. diff --git a/jetstream/model_deep_dive/README.md b/jetstream/model_deep_dive.md similarity index 97% rename from jetstream/model_deep_dive/README.md rename to jetstream/model_deep_dive.md index 7c2055b..5b51081 100644 --- a/jetstream/model_deep_dive/README.md +++ b/jetstream/model_deep_dive.md @@ -24,9 +24,9 @@ In both `WorkQueuePolicy` and `InterestPolicy` the age, size and count limits wi A final control is the Maximum Size any single message may have. NATS have it's own limit for maximum size \(1 MiB by default\), but you can say a Stream will only accept messages up to 1024 bytes using `MaxMsgSize`. -The `Discard Policy` sets how messages are discard when limits set by `LimitsPolicy` are reached. The `DiscardOld` option removes old messages making space for new, while `DiscardNew` refuses any new messages. +The `Discard Policy` sets how messages are discarded when limits set by `LimitsPolicy` are reached. The `DiscardOld` option removes old messages making space for new, while `DiscardNew` refuses any new messages. -The `WorkQueuePolicy` mode is a specialized mode where a message, once consumed and acknowledged, is discarded from the Stream. In this mode there are a few limits on consumers. Inherently it's about 1 message to one consumer, this means you cannot have overlapping consumers defined on the Stream - needs unique filter subjects. +The `WorkQueuePolicy` mode is a specialized mode where a message, once consumed and acknowledged, is discarded from the Stream. In this mode, there are a few limits on consumers. Inherently it's about 1 message to one consumer, this means you cannot have overlapping consumers defined on the Stream - needs unique filter subjects. ## Message Deduplication @@ -208,7 +208,7 @@ The `+NXT` acknowledgement can have a few formats: `+NXT 10` requests 10 message JetStream supports Exactly Once delivery by combining Message Deduplication and double acks. -On the publishing side you can avoid duplicate message ingestion using the [Message Deduplication](./#message-deduplication) feature. +On the publishing side you can avoid duplicate message ingestion using the [Message Deduplication](model_deep_dive.md#message-deduplication) feature. Consumers can be 100% sure a message was correctly processed by requesting the server Acknowledge having received your acknowledgement by setting a reply subject on the Ack. If you receive this response you will never receive that message again. diff --git a/jetstream/model_deep_dive/ack-sampling.md b/jetstream/model_deep_dive/ack-sampling.md deleted file mode 100644 index eedc01d..0000000 --- a/jetstream/model_deep_dive/ack-sampling.md +++ /dev/null @@ -1,2 +0,0 @@ -# Ack Sampling - diff --git a/jetstream/model_deep_dive/acknowledgment-models.md b/jetstream/model_deep_dive/acknowledgment-models.md deleted file mode 100644 index 1b1561d..0000000 --- a/jetstream/model_deep_dive/acknowledgment-models.md +++ /dev/null @@ -1,2 +0,0 @@ -# Acknowledgment Models - diff --git a/jetstream/model_deep_dive/consumer-message-rates.md b/jetstream/model_deep_dive/consumer-message-rates.md deleted file mode 100644 index f3401a1..0000000 --- a/jetstream/model_deep_dive/consumer-message-rates.md +++ /dev/null @@ -1,2 +0,0 @@ -# Consumer Message Rates - diff --git a/jetstream/model_deep_dive/consumer-starting-position.md b/jetstream/model_deep_dive/consumer-starting-position.md deleted file mode 100644 index 2e2b6b8..0000000 --- a/jetstream/model_deep_dive/consumer-starting-position.md +++ /dev/null @@ -1,2 +0,0 @@ -# Consumer Starting Position - diff --git a/jetstream/model_deep_dive/ephemeral-consumers.md b/jetstream/model_deep_dive/ephemeral-consumers.md deleted file mode 100644 index f12004a..0000000 --- a/jetstream/model_deep_dive/ephemeral-consumers.md +++ /dev/null @@ -1,2 +0,0 @@ -# Ephemeral Consumers - diff --git a/jetstream/model_deep_dive/exactly-once-delivery.md b/jetstream/model_deep_dive/exactly-once-delivery.md deleted file mode 100644 index 2bc6b24..0000000 --- a/jetstream/model_deep_dive/exactly-once-delivery.md +++ /dev/null @@ -1,2 +0,0 @@ -# Exactly Once Delivery - diff --git a/jetstream/model_deep_dive/message-deduplication.md b/jetstream/model_deep_dive/message-deduplication.md deleted file mode 100644 index 98ab7f5..0000000 --- a/jetstream/model_deep_dive/message-deduplication.md +++ /dev/null @@ -1,2 +0,0 @@ -# Message Deduplication - diff --git a/jetstream/model_deep_dive/storage-overhead.md b/jetstream/model_deep_dive/storage-overhead.md deleted file mode 100644 index bc9a5e4..0000000 --- a/jetstream/model_deep_dive/storage-overhead.md +++ /dev/null @@ -1,2 +0,0 @@ -# Storage Overhead - diff --git a/jetstream/model_deep_dive/stream-limits-retention-modes-and-discard-policy.md b/jetstream/model_deep_dive/stream-limits-retention-modes-and-discard-policy.md deleted file mode 100644 index 00be723..0000000 --- a/jetstream/model_deep_dive/stream-limits-retention-modes-and-discard-policy.md +++ /dev/null @@ -1,2 +0,0 @@ -# Stream Limits, Retention Modes and Discard Policy - diff --git a/jetstream/model_deep_dive/stream-templates.md b/jetstream/model_deep_dive/stream-templates.md deleted file mode 100644 index 95ed438..0000000 --- a/jetstream/model_deep_dive/stream-templates.md +++ /dev/null @@ -1,2 +0,0 @@ -# Stream Templates -