Skip to content

Commit

Permalink
chore: use embeds for installacion command
Browse files Browse the repository at this point in the history
  • Loading branch information
morenol committed Oct 28, 2024
1 parent 0077176 commit bc5ceeb
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 16 deletions.
1 change: 1 addition & 0 deletions sdf/_embeds/install-sdf.bash
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
fvm install sdf-beta3
7 changes: 4 additions & 3 deletions sdf/cli/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
<CodeBlock language="bash">{InstallFvm}</CodeBlock>

### SDF Commands

Expand Down
3 changes: 0 additions & 3 deletions sdf/composition/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
9 changes: 5 additions & 4 deletions sdf/composition/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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
```
<CodeBlock language="bash">{InstallFvm}</CodeBlock>

You can validate prerequisites with:

Expand Down Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions sdf/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
```
<CodeBlock language="bash">{InstallFvm}</CodeBlock>

### 2. Create the Dataflow file

Expand Down
7 changes: 4 additions & 3 deletions sdf/whatsnew.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
<CodeBlock language="bash">{InstallFvm}</CodeBlock>

To upgrade host workers, shutdown and restart the worker:

Expand Down

0 comments on commit bc5ceeb

Please sign in to comment.