Skip to content

Commit fd10c69

Browse files
authored
beta2 updates (#271)
updated what's new section update `beta1.1` -> beta2
1 parent 4cdf022 commit fd10c69

File tree

4 files changed

+61
-12
lines changed

4 files changed

+61
-12
lines changed

sdf/cli/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ $ curl -fsS https://hub.infinyon.cloud/install/install.sh | bash
1717
2. Install the preview release:
1818

1919
```bash copy="fl"
20-
$ fvm install sdf-beta1.1
20+
$ fvm install sdf-beta2
2121
```
2222

2323
### SDF Commands

sdf/composition/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ Your Fluvio cluster is ready for use.
6666
SDF is in beta and it requires the following image:
6767

6868
```bash
69-
fvm install sdf-beta1.1
69+
fvm install sdf-beta2
7070
```
7171

7272
You can validate prerequisites with:

sdf/quickstart.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Let's create a simple dataflow to split a sentence into words and count the word
3636
Stateful dataflows are managed via [sdf cli] that we install it using [fvm].
3737

3838
```
39-
$ fvm install sdf-beta1.1
39+
$ fvm install sdf-beta2
4040
```
4141

4242
### 2. Create the Dataflow file

sdf/whatsnew.mdx

Lines changed: 58 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,61 @@ sidebar_position: 20
66

77
# Beta 2
88

9+
## Upgrading
10+
11+
To upgrade CLI to the beta2, run the following command:
12+
13+
```bash
14+
$ fvm install sdf-beta2
15+
```
16+
17+
To upgrade host workers, shutdown and restart the worker:
18+
19+
```bash
20+
$ sdf worker shutdown <host-worker-name>
21+
$ sdf worker create <host-worker-name>
22+
```
23+
24+
For upgrading cloud workers, please contact [InfinyOn support](#infinyon-support).
25+
26+
### Compatibility and Breaking changes
27+
28+
`0.4.0` version of dataflow is no longer supported. Please upgrade to `0.5.0`.
29+
The version of the dataflow is specified in the `apiVersion` field in the dataflow file.
30+
31+
32+
33+
### CLI changes
34+
35+
Publishing command is simplified.
36+
`sdf hub publish` -> `sdf publish`
37+
38+
39+
`run` command is separated into `run` and `deploy`. Please see [deployment] for details:
40+
41+
To run dataflow in ephemeral mode:
42+
Beta1.1: `sdf run --ephemeral`
43+
Beta2: `sdf run`
44+
45+
46+
To run dataflow in a worker:
47+
Beta1.1: `sdf run`,
48+
Beta2: `sdf deploy`
49+
50+
51+
### Package migration
52+
53+
Since beta2, the packages functions are consolidated in a single rust crate on generation. This allows us to share types and logic between different package functions.
54+
55+
In order to migrate your existing packages, you need to generate your package (`sdf generate`) using the `sdf-beta2` version and then copy the code in the new location of the generated code.
56+
57+
In other words, for each function, the logic in `rust/<function-name>/src/lib.rs` must be copied on `rust/<package-name>/src/<function_name>.rs`. But please, make sure that all the attributes in `#[sdf]` attribute macro matches with the attributes that we get on code generation.
58+
59+
60+
961
## New Features
1062

11-
- Support for customizing JSON serialization and deserialization
63+
- Support for customizing JSON serialization and deserialization (see [custom serialization])
1264

1365
## Improvements
1466

@@ -24,21 +76,18 @@ sidebar_position: 20
2476
- Worker: Worker listing with `-all` shows the version.
2577
- Config: Producer config now supports `compression`, `isolation`, and `timeout`.
2678
- Cloud: Cloud supports larger worker storage.
79+
- Cloud: Secret support
2780
- Package: Generated codes are consolidated and hidden from developers.
2881
- Operator: Operator error messages are sent to log.
2982

3083
## Bug Fixes
3184
- CLI show list of created topics
3285

33-
## Breaking Changes
34-
35-
V4 of dataflow is no longer supported. Please upgrade to V5.
86+
## InfinyOn Support
3687

37-
## Package migration
88+
For any questions or issues, please contact InfinyOn support at support@infinyon.com or https://discordapp.com/invite/bBG2dTz
3889

39-
Since beta2, the packages functions are consolidated in a single rust crate on generation. This allows us to share types and logic between different package functions.
40-
41-
In order to migrate your existing packages, you need to generate your package (`sdf generate`) using the `sdf-beta2` version and then copy the code in the new location of the generated code.
4290

43-
In other words, for each function, the logic in `rust/<function-name>/src/lib.rs` must be copied on `rust/<package-name>/src/<function_name>.rs`. But please, make sure that all the attributes in `#[sdf]` attribute macro matches with the attributes that we get on code generation.
91+
[deployment]: deployment.mdx
92+
[custom serialization]: concepts/custom-serialization.mdx
4493

0 commit comments

Comments
 (0)