Fluvio - Connector Development Kit (CDK)

We are hiring! Apply here

Connector Development Kit (CDK)

Check out the Connector Development Kit page for more information.

Connector Development Kit
Usage: cdk <COMMAND>
Commands:
  build       Build the Connector in the current working directory
  test        Build and run the Connector in the current working directory
  generate    Generate new SmartConnector project
  deploy      Deploy the Connector from the current working directory
  publish     Publish Connector package to the Hub
  set-public  Set connector visibility to public
  help        Print this message or the help of the given subcommand(s)
Options:
  -h, --help  Print help

`cdk build`

Build the Connector in the current working directory
Usage: cdk build [OPTIONS] [-- <EXTRA_ARGUMENTS>...]
Arguments:
  [EXTRA_ARGUMENTS]...  Extra arguments to be passed to cargo
Options:
      --release <RELEASE>            Release profile name [default: release]
  -p, --package-name <PACKAGE_NAME>  Optional package/project name
  -h, --help                         Print help

`cdk generate`

Generate new SmartConnector project
Usage: cdk generate [OPTIONS] [NAME]
Arguments:
  [NAME]  SmartConnector Project Name
Options:
      --destination <PATH>  Local path to generate the SmartConnector project. Default to directory
                            with project name, created in current directory [env: CDK_DESTINATION=]
  -h, --help                Print help (see more with '--help')

`cdk test`

Build and run the Connector in the current working directory
Usage: cdk test [OPTIONS] [-- <EXTRA_ARGUMENTS>...]
Arguments:
  [EXTRA_ARGUMENTS]...  Extra arguments to be passed to cargo
Options:
      --release <RELEASE>            Release profile name [default: release]
  -p, --package-name <PACKAGE_NAME>  Optional package/project name
  -c, --config <PATH>                Path to configuration file in YAML format [default:
                                     sample-config.yaml]
  -s, --secrets <PATH>               Path to file with secrets. Secrets are 'key=value' pairs
                                     separated by the new line character. Optional
  -h, --help                         Print help

`cdk deploy`

Deploy the Connector from the current working directory
Usage: cdk deploy [OPTIONS] [-- <EXTRA_ARGUMENTS>...] <COMMAND>
Commands:
  start     Start new deployment for the given connector config
  shutdown  Shutdown the Connector's deployment
  list      Print the list of all deployed connectors
  log       Print the connector's logs
  help      Print this message or the help of the given subcommand(s)
Arguments:
  [EXTRA_ARGUMENTS]...  Extra arguments to be passed to cargo
Options:
      --release <RELEASE>            Release profile name [default: release]
  -p, --package-name <PACKAGE_NAME>  Optional package/project name
  -h, --help                         Print help

`cdk deploy start`

Start new deployment for the given connector config
Usage: cdk deploy start [OPTIONS] --config <PATH>
Options:
  -c, --config <PATH>   Path to configuration file in YAML format
  -s, --secrets <PATH>  Path to file with secrets. Secrets are 'key=value' pairs separated by the
                        new line character. Optional
      --ipkg <PATH>     Deploy from local package file
  -h, --help            Print help

`cdk deploy shutdown`

Shutdown the Connector's deployment
Usage: cdk deploy shutdown <--config <PATH>|--name <CONNECTOR_NAME>>

Options:
  -c, --config <PATH>          Path to configuration file in YAML format
  -n, --name <CONNECTOR_NAME>  Name of the connector to shutdown
  -h, --help                   Print help

`cdk deploy list`

Print the list of all deployed connectors
Usage: cdk deploy list
Options:
  -h, --help  Print help

`cdk deploy log`

Print the connector's logs		  <CONNECTOR_NAME>  
Usage: cdk deploy log <CONNECTOR_NAME>	Options:
Arguments:				  -h, --help  Print help

`cdk publish`

Publish Connector package to the Hub
Usage: cdk publish [OPTIONS] [PACKAGE_META]
Arguments:
  [PACKAGE_META]  
Options:
      --public-yes       don't ask for confirmation of public package publish
      --target <TARGET>  provide target platform for the package. Optional. By default the host's
                         one is used [default: aarch64-apple-darwin]
  -h, --help             Print help (see more with '--help')

Edit this page