diff --git a/sdf/_embeds/install-sdf.bash b/sdf/_embeds/install-sdf.bash new file mode 100644 index 00000000..80d5a53d --- /dev/null +++ b/sdf/_embeds/install-sdf.bash @@ -0,0 +1 @@ +fvm install sdf-beta3 \ No newline at end of file diff --git a/sdf/cli/index.mdx b/sdf/cli/index.mdx index 1ae842ac..12002737 100644 --- a/sdf/cli/index.mdx +++ b/sdf/cli/index.mdx @@ -4,6 +4,9 @@ description: Stateful Dataflows Command Line Interface. sidebar_position: 10 --- +import CodeBlock from '@theme/CodeBlock'; +import InstallFvm from '!!raw-loader!../_embeds/install-sdf.bash'; + Stateful Dataflows (sdf) is a binary, shipped with fluvio, that helps developers build, test, and deploy packages and dataflows. ### Install SDF @@ -16,9 +19,7 @@ $ curl -fsS https://hub.infinyon.cloud/install/install.sh | bash 2. Install the preview release: -```bash copy="fl" -$ fvm install sdf-beta2 -``` +{InstallFvm} ### SDF Commands diff --git a/sdf/composition/overview.mdx b/sdf/composition/overview.mdx index d535a5ff..2ac33dad 100644 --- a/sdf/composition/overview.mdx +++ b/sdf/composition/overview.mdx @@ -91,13 +91,10 @@ The sections are as follows: * `functions` - defines functions in the package * `dev` - defines substitutions used during development and test -# Dataflows - ## The Dataflow The **dataflow** imports functions, types, and states from one more package. Packages may also import components from others; however, dataflow maintains the final composition. - #### `dataflow.yaml` The [SDF] command line tool uses the dataflow definition file `dataflow.yaml` to assemble the data application, and it has the following hierarchy: diff --git a/sdf/composition/quickstart.mdx b/sdf/composition/quickstart.mdx index 66439fa7..30a2dfdb 100644 --- a/sdf/composition/quickstart.mdx +++ b/sdf/composition/quickstart.mdx @@ -4,6 +4,9 @@ description: Guide on how to create Stateful Dataflows using the Stateful Datafl sidebar_position: 20 --- +import CodeBlock from '@theme/CodeBlock'; +import InstallFvm from '!!raw-loader!../_embeds/install-sdf.bash'; + # Getting Started with Stateful Dataflows This guide will get you started with [SDF], an utility that helps developers build, troubleshoot, and run full-featured event-driven dataflows. @@ -60,9 +63,7 @@ Your Fluvio cluster is ready for use. SDF is in beta and it requires the following image: -```bash -fvm install sdf-beta3 -``` +{InstallFvm} You can validate prerequisites with: @@ -369,7 +370,7 @@ For additional examples, check out [stateful-dataflows-examples] in github. The Stateful Dataflows is an ambitious project with many possibilities and just as many hazards. Please get in touch, we would love to hear your feedback and help us steer the product in the right direction. -[SDF]: sdf +[SDF]: ../../ [composition]: overview.mdx [stateful-dataflows-examples]: https://github.com/infinyon/stateful-dataflows-examples [github]: https://github.com/infinyon/stateful-dataflows-examples/tree/main/dataflows-composed/split-sentence diff --git a/sdf/quickstart.mdx b/sdf/quickstart.mdx index f1fa27da..07bd0735 100644 --- a/sdf/quickstart.mdx +++ b/sdf/quickstart.mdx @@ -4,6 +4,10 @@ description: Getting started with Stateful Dataflows sidebar_position: 10 --- +import CodeBlock from '@theme/CodeBlock'; +import InstallFvm from '!!raw-loader!./_embeds/install-sdf.bash'; + + # SDF Quickstart Provisioning and operating a Stateful Dataflow requires the following system components: @@ -35,9 +39,7 @@ Let's create a simple dataflow to split a sentence into words and count the word Stateful dataflows are managed via [sdf cli] that we install it using [fvm]. -``` -$ fvm install sdf-beta2 -``` +{InstallFvm} ### 2. Create the Dataflow file diff --git a/sdf/whatsnew.mdx b/sdf/whatsnew.mdx index 91ae727f..01b32d33 100644 --- a/sdf/whatsnew.mdx +++ b/sdf/whatsnew.mdx @@ -4,15 +4,16 @@ description: Changes and updates to SDF sidebar_position: 20 --- +import CodeBlock from '@theme/CodeBlock'; +import InstallFvm from '!!raw-loader!./_embeds/install-sdf.bash'; + # Beta 3 ## Upgrading To upgrade CLI to the beta3, run the following command: -```bash -$ fvm install sdf-beta3 -``` +{InstallFvm} To upgrade host workers, shutdown and restart the worker: