@restatedev/restate 1.2.2 → 1.3.0-rc.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +27 -23
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -1,31 +1,33 @@
1
1
  [![Documentation](https://img.shields.io/badge/doc-reference-blue)](https://docs.restate.dev)
2
2
  [![Examples](https://img.shields.io/badge/view-examples-blue)](https://github.com/restatedev/examples)
3
3
  [![Discord](https://img.shields.io/discord/1128210118216007792?logo=discord)](https://discord.gg/skW3AZ6uGd)
4
- [![Twitter](https://img.shields.io/twitter/follow/restatedev.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=restatedev)
4
+ [![Slack](https://img.shields.io/badge/Slack-4A154B?logo=slack&logoColor=fff)](https://join.slack.com/t/restatecommunity/shared_invite/zt-2v9gl005c-WBpr167o5XJZI1l7HWKImA)
5
+ [![Twitter](https://img.shields.io/twitter/follow/restatedev.svg?style=social&label=Follow)](https://x.com/intent/follow?screen_name=restatedev)
5
6
 
6
7
  # Restate - Building resilient applications made easy!
7
8
 
8
9
  <p align="center">
9
10
  <picture>
10
- <source media="(prefers-color-scheme: dark)" srcset="https://restate.dev/poster_intro_dark.svg">
11
- <source media="(prefers-color-scheme: light)" srcset="https://restate.dev/poster_intro_2.svg">
12
- <img alt="Restate overview" src="https://restate.dev/poster_intro_2.svg" width="500">
11
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/restatedev/img/refs/heads/main/restate-overview-light.png">
12
+ <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/restatedev/img/refs/heads/main/restate-overview-dark.png">
13
+ <img alt="Restate overview" src="https://raw.githubusercontent.com/restatedev/img/refs/heads/main/restate-overview-dark.png" width="650">
13
14
  </picture>
14
15
  </p>
15
16
 
16
- Easily build workflows, event-driven applications, and distributed services in a fault-tolerant manner with durable async/await.
17
+ [Restate](https://restate.dev) is the simplest way to build resilient applications.
17
18
 
18
- [Restate](https://restate.dev) is great at building:
19
+ Restate provides a distributed durable version of your everyday building blocks, letting you build a wide range of use cases:
19
20
 
20
- * [Lambda Workflows as Code](https://restate.dev/blog/we-replaced-400-lines-of-stepfunctions-asl-with-40-lines-of-typescript-by-making-lambdas-suspendable/)
21
- * [Transactional RPC Handlers](https://github.com/restatedev/examples/tree/main/end-to-end-applications/typescript/food-ordering)
22
- * [Event Processing with Kafka](https://restate.dev/blog/restate--kafka-event-driven-apps-where-event-driven-is-an-implementation-detail/)
23
- * [Much more](https://github.com/restatedev/examples)
21
+ * [Workflows-as-Code](https://docs.restate.dev/use-cases/workflows)
22
+ * [Microservice orchestration](https://docs.restate.dev/use-cases/microservice-orchestration)
23
+ * [Event Processing](https://docs.restate.dev/use-cases/event-processing)
24
+ * [Async Tasks](https://docs.restate.dev/use-cases/async-tasks)
25
+ * [Agents, Stateful Actors, state machines, and much more](https://github.com/restatedev/examples)
24
26
 
25
27
  ## Get started with Restate
26
28
 
27
- 1. 🏎 [Check out our quickstart](https://docs.restate.dev/get_started/quickstart) to get up and running with Restate in 2 minutes!
28
- 1. 💡 [The tour of Restate](https://docs.restate.dev/get_started/tour) walks you through all features of Restate.
29
+ 1. 🏎 [Follow the Quickstart](https://docs.restate.dev/get_started/quickstart) to get Restate up and running within 2 minutes!
30
+ 1. 💡 [The Tour of Restate](https://docs.restate.dev/get_started/tour) walks you through the most important features of Restate.
29
31
 
30
32
  ## SDKs
31
33
 
@@ -41,6 +43,8 @@ Restate supports the following SDKs:
41
43
 
42
44
  We offer pre-built binaries of the CLI and the server for MacOS and Linux.
43
45
 
46
+ Have a look at the [Quickstart](https://docs.restate.dev/get_started/quickstart) or [installation instructions in the docs](https://docs.restate.dev/develop/local_dev).
47
+
44
48
  ### Install the server
45
49
 
46
50
  Install via Homebrew:
@@ -55,7 +59,8 @@ npx @restatedev/restate-server
55
59
 
56
60
  Run via docker:
57
61
  ```bash
58
- docker run --rm -it --network=host docker.restate.dev/restatedev/restate:latest
62
+ docker run --rm -p 8080:8080 -p 9070:9070 -p 9071:9071 \
63
+ --add-host=host.docker.internal:host-gateway docker.restate.dev/restatedev/restate:latest
59
64
  ```
60
65
 
61
66
  ### Install the CLI
@@ -79,8 +84,8 @@ You can also download the binaries from the [release page](https://github.com/re
79
84
 
80
85
  ## Community
81
86
 
82
- * 🤗️ [Join our online community](https://discord.gg/skW3AZ6uGd) for help, sharing feedback and talking to the community.
83
- * 📖 [Check out our documentation](https://docs.restate.dev) to get quickly started!
87
+ * 🤗️ Join our online community on [Discord](https://discord.gg/skW3AZ6uGd) or [Slack](https://join.slack.com/t/restatecommunity/shared_invite/zt-2v9gl005c-WBpr167o5XJZI1l7HWKImA) for help, sharing feedback and talking to the community.
88
+ * 📖 [Check out our documentation](https://docs.restate.dev) to get started quickly!
84
89
  * 📣 [Follow us on Twitter](https://twitter.com/restatedev) for staying up to date.
85
90
  * 🙋 [Create a GitHub issue](https://github.com/restatedev/restate/issues) for requesting a new feature or reporting a problem.
86
91
  * 🏠 [Visit our GitHub org](https://github.com/restatedev) for exploring other repositories.
@@ -89,13 +94,12 @@ You can also download the binaries from the [release page](https://github.com/re
89
94
 
90
95
  The basic primitives Restate offers to simplify application development are the following:
91
96
 
92
- * **Reliable Execution**: user code will always run to completion. Intermediate failures result in re-tries that use the durable execution mechanism to recover partial progress and not duplicate already executed steps.
93
- * **Suspending User Code**: long-running user code suspends when awaiting on a promise and resume when that promise is resolved.
94
- * **Reliable Communication**: user code communicates with exactly-once semantics. Restate reliably delivers messages and anchors both sender and receiver in the durable execution to ensure no losses or duplicates can happen.
95
- * **Durable Timers**: user code can sleep (and suspend) or schedule calls for later.
96
- * **Isolation**: user code can be keyed, which makes Restate scheduled them to obey single-writer-per-key semantics.
97
- * **Consistent State**: keyed user code can attach key/value state, which is eagerly pushed into handlers during invocation, and written back upon completion. This is particularly efficient for FaaS deployments (stateful serverless, yay!).
98
- * **Observability & Introspection**: Restate automatically generates Open Telemetry traces for the interactions between handlers and gives you a SQL shell to query the distributed state of the application.
97
+ * **Reliable Execution**: Restate guarantees code runs to completion. Failures result in retries that use the [Durable Execution mechanism](https://docs.restate.dev/concepts/durable_execution) to recover partial progress and prevent re-executing completed steps.
98
+ * **Reliable Communication**: Services communicate with exactly-once semantics: whether it's [request-response, one-way messages, or scheduled tasks](https://docs.restate.dev/concepts/invocations). Restate reliably delivers messages and uses Durable Execution to ensure no losses or duplicates can happen.
99
+ * **Durable Promises and Timers**: Register Promises/Futures and timers in Restate to make them resilient to failures (e.g. sleep, webhooks, timers). Restate can recover them across failures, processes, and time.
100
+ * **Consistent State**: Implement [stateful entities](https://docs.restate.dev/concepts/services) with isolated K/V state per entity. Restate persists the K/V state updates together with the execution progress to ensure consistent state. Restate attaches the K/V state to the request on invocation, and writes it back upon completion. This is particularly efficient for FaaS deployments (stateful serverless, yay!).
101
+ * **Suspending User Code**: long-running code suspends when awaiting on a Promise/Future and resumes when that promise is resolved. This is particularly useful in combination with serverless deployments.
102
+ * **Observability & Introspection**: Restate includes a UI and CLI to inspect the [state of your application](https://docs.restate.dev/operate/introspection) across services and invocations. Restate automatically generates Open Telemetry traces for the interactions between handlers.
99
103
 
100
104
  ## Contributing
101
105
 
@@ -113,7 +117,7 @@ You can safely upgrade from a Restate `x.y` to `x.(y+1)` release without perform
113
117
 
114
118
  For SDK compatibility, refer to the supported version matrix in the respective READMEs:
115
119
 
116
- * [Restate Java SDK](https://github.com/restatedev/sdk-java#versions)
120
+ * [Restate Java/Kotlin SDK](https://github.com/restatedev/sdk-java#versions)
117
121
  * [Restate TypeScript SDK](https://github.com/restatedev/sdk-typescript#versions)
118
122
  * [Restate Go SDK](https://github.com/restatedev/sdk-go#versions)
119
123
  * [Restate Python SDK](https://github.com/restatedev/sdk-python#versions)
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@restatedev/restate",
3
3
  "description": "The Restate CLI",
4
- "version": "1.2.2",
4
+ "version": "1.3.0-rc.2",
5
5
  "bin": "lib/index.js",
6
6
  "repository": {
7
7
  "type": "git",
@@ -35,9 +35,9 @@
35
35
  "typescript": "^4.9.4"
36
36
  },
37
37
  "optionalDependencies": {
38
- "@restatedev/restate-linux-x64": "1.2.2",
39
- "@restatedev/restate-linux-arm64": "1.2.2",
40
- "@restatedev/restate-darwin-x64": "1.2.2",
41
- "@restatedev/restate-darwin-arm64": "1.2.2"
38
+ "@restatedev/restate-linux-x64": "1.3.0-rc.2",
39
+ "@restatedev/restate-linux-arm64": "1.3.0-rc.2",
40
+ "@restatedev/restate-darwin-x64": "1.3.0-rc.2",
41
+ "@restatedev/restate-darwin-arm64": "1.3.0-rc.2"
42
42
  }
43
43
  }