From 57e584aa7ff2241ade84eeb94d358860cb64bf22 Mon Sep 17 00:00:00 2001 From: "Alessandro (Ale) Segala" <43508+ItalyPaleAle@users.noreply.github.com> Date: Mon, 7 Aug 2023 20:12:28 -0700 Subject: [PATCH] Add warning that NATS Streaming is deprecated (#3666) * Add warning that NATS Streaming is deprecated Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Mark Fussell Signed-off-by: Alessandro (Ale) Segala <43508+ItalyPaleAle@users.noreply.github.com> * Updated breaking-changes table Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com> --------- Signed-off-by: ItalyPaleAle <43508+ItalyPaleAle@users.noreply.github.com> Signed-off-by: Alessandro (Ale) Segala <43508+ItalyPaleAle@users.noreply.github.com> Co-authored-by: Mark Fussell --- .../support/breaking-changes-and-deprecations.md | 15 ++++++++++----- .../supported-pubsub/setup-nats-streaming.md | 13 +++++++++---- daprdocs/data/components/pubsub/generic.yaml | 4 ++-- 3 files changed, 21 insertions(+), 11 deletions(-) diff --git a/daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md b/daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md index 76c71eed3..d0aeab507 100644 --- a/daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md +++ b/daprdocs/content/en/operations/support/breaking-changes-and-deprecations.md @@ -21,12 +21,12 @@ Breaking changes are defined as a change to any of the following that cause comp Breaking changes can be applied right away to the following cases: -- Projects versioned at 0.x.y +- Projects that have not reached version 1.0.0 yet - Preview feature - Alpha API - Preview or Alpha interface, class, method or attribute in SDK - Dapr Component in Alpha or Beta -- Components-Contrib interface +- Interfaces for `github.com/dapr/components-contrib` - URLs in Docs and Blog - An **exceptional** case where it is **required** to fix a critical bug or security vulnerability. @@ -39,7 +39,9 @@ There is a process for applying breaking changes: - For example, feature X is announced to be deprecated in the 1.0.0 release notes and will then be removed in 1.2.0. ## Deprecations -Deprecations can apply to + +Deprecations can apply to: + 1. APIs, including alpha APIs 1. Preview features 1. Components @@ -58,11 +60,14 @@ After announcing a future breaking change, the change will happen in 2 releases | Feature | Deprecation announcement | Removal | |-----------------------|-----------------------|------------------------- | -| GET /v1.0/shutdown API (Users should use [POST API]({{< ref kubernetes-job.md >}}) instead) | 1.2.0 | 1.4.0 | +| GET /v1.0/shutdown API (Users should use [POST API]({{< ref kubernetes-job.md >}}) instead) | 1.2.0 | 1.4.0 | | Java domain builder classes deprecated (Users should use [setters](https://github.com/dapr/java-sdk/issues/587) instead) | Java SDK 1.3.0 | Java SDK 1.5.0 | -| Service invocation will no longer provide a default content type header of `application/json` when no content-type is specified. You must explicitly [set a content-type header]({{< ref "service_invocation_api.md#request-contents" >}}) for service invocation if your invoked apps rely on this header. | 1.7.0 | 1.9.0 | +| Service invocation will no longer provide a default content type header of `application/json` when no content-type is specified. You must explicitly [set a content-type header]({{< ref "service_invocation_api.md#request-contents" >}}) for service invocation if your invoked apps rely on this header. | 1.7.0 | 1.9.0 | | gRPC service invocation using `invoke` method is deprecated. Use proxy mode service invocation instead. See [How-To: Invoke services using gRPC ]({{< ref howto-invoke-services-grpc.md >}}) to use the proxy mode.| 1.9.0 | 1.10.0 | | The CLI flag `--app-ssl` (in both the Dapr CLI and daprd) has been deprecated in favor of using `--app-protocol` with values `https` or `grpcs`. [daprd:6158](https://github.com/dapr/dapr/issues/6158) [cli:1267](https://github.com/dapr/cli/issues/1267)| 1.11.0 | 1.13.0 | +| Hazelcast PubSub Component | 1.9.0 | 1.11.0 | +| Twitter Binding Component | 1.10.0 | 1.11.0 | +| NATS Streaming PubSub Component | 1.11.0 | 1.13.0 | ## Related links diff --git a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md index 5ac1f720d..3a2f9d219 100644 --- a/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md +++ b/daprdocs/content/en/reference/components-reference/supported-pubsub/setup-nats-streaming.md @@ -7,7 +7,16 @@ aliases: - "/operations/components/setup-pubsub/supported-pubsub/setup-nats-streaming/" --- +## ⚠️ Deprecation notice + +{{% alert title="Warning" color="warning" %}} +This component is **deprecated** because the [NATS Streaming Server](hhttps://nats-io.gitbook.io/legacy-nats-docs/nats-streaming-server-aka-stan/developing-with-stan) was deprecated in June 2023 and no longer receives updates. Users are encouraged to switch to using [JetStream]({{< ref setup-jetstream >}} as an alternative. + +This component will be **removed in the Dapr v1.13 release. +{{% /alert %}} + ## Component format + To set up NATS Streaming pub/sub, create a component of type `pubsub.natsstreaming`. See the [pub/sub broker component file]({{< ref setup-pubsub.md >}}) to learn how ConsumerID is automatically generated. Read the [How-to: Publish and Subscribe guide]({{< ref "howto-publish-subscribe.md#step-1-setup-the-pubsub-component" >}}) on how to create and apply a pub/sub configuration. ```yaml @@ -57,10 +66,6 @@ spec: The above example uses secrets as plain strings. It is recommended to [use a secret store for the secrets]({{< ref component-secrets.md >}}). {{% /alert %}} -{{% alert title="Warning" color="warning" %}} -NATS Streaming has been [deprecated](https://github.com/nats-io/nats-streaming-server/#warning--deprecation-notice-warning). Consider using [NATS JetStream]({{< ref setup-jetstream >}}) going forward. -{{% /alert %}} - ## Spec metadata fields | Field | Required | Details | Example | diff --git a/daprdocs/data/components/pubsub/generic.yaml b/daprdocs/data/components/pubsub/generic.yaml index 38d775c63..99fa5cd20 100644 --- a/daprdocs/data/components/pubsub/generic.yaml +++ b/daprdocs/data/components/pubsub/generic.yaml @@ -48,9 +48,9 @@ bulkSubscribe: false - component: NATS Streaming link: setup-nats-streaming - state: Beta + state: Deprecated version: v1 - since: "1.0" + since: "1.11" features: bulkPublish: false bulkSubscribe: false