Skip to main content
Version: latest

Generate

SMDK generate helps developers build a sample SmartModule project by answering a few simple questions.

Generate - Operation​

SMDK generate commands runs a wizard and builds a sample project in a subdirectory

$ smdk generate my-filter

Generating new SmartModule project: my-filter
fluvio-smartmodule-cargo-dependency => '"0.2.5"'
🔧   Destination: ~/smdk/my-filter ...
🔧   Generating template ...
🤷   Will your SmartModule use init parameters? · false
🤷   Which type of SmartModule would you like? · filter
🤷   Will your SmartModule be public? · false
🤷   Please set a group name : acme
[1/5]   Done: Cargo.toml
[2/5]   Done: README.md
[3/5]   Done: SmartModule.toml
[4/5]   Done: src/lib.rs
[5/5]   Done: src
🔧   Moving generated files into: `~/smdk/my-filter`...
💡   Initializing a fresh Git repository
✨   Done! New project created ~/smdk/my-filter
hub: hubid acme is set

The generator created Rust project ready to compile:

$ tree
.
├── Cargo.toml
├── README.md
├── SmartModule.toml
└── src
    └── lib.rs

This is a simple SmartModule filter matching for all data records that contains letter a:

use fluvio_smartmodule::{smartmodule, Result, SmartModuleRecord};

#[smartmodule(filter)]
pub fn filter(record: &SmartModuleRecord) -> Result<bool> {
    let string = std::str::from_utf8(record.value.as_ref())?;
    Ok(string.contains('a'))
}

Note the SmartModule.toml file. This file contains SmartModule parameters required to load the file in the Cluster and publish it to SmartModule Hub.

$ cat SmartModule.toml

[package]
name = "my-filter"
group = "acme"
version = "0.1.0"
apiVersion = "0.1.0"
description = ""
license = "Apache-2.0"

[[params]]
name = "input"
description = "input description"

Sections​

  • package is used to build the SmartModule FQDN acme/my-filter@0.1.0, and the description to publish to SmartModule Hub. The group name is equivalent to the package owner in the Hub.
  • params defines the command line parameters by the SmartModule internal logic.

The project is ready to build and test. Checkout the next section for instructions.

Steps​

  1. Generate a SmartModule
  2. Build and Test
  3. Load to your Cluster
  4. Publish to SmartModule Hub