diff --git a/content/connectors/cdk/github-examples.md b/content/connectors/cdk/github-examples.md index 316e4ff3..3a91fb92 100644 --- a/content/connectors/cdk/github-examples.md +++ b/content/connectors/cdk/github-examples.md @@ -5,11 +5,11 @@ weight: 90 We have a library of connectors in github you may use as inspiration as you build your own. `Connector-Hello` would be a good starting point, but feel free to checkout the others as well. -#### Template Connectors +### Template Connectors * https://github.com/infinyon/connector-hello -#### Official Connectors +### Official Connectors Source code repo for the InfinyOn official connectors: @@ -20,14 +20,17 @@ Source code repo for the InfinyOn official connectors: * https://github.com/infinyon/mqtt-connector * https://github.com/infinyon/graphite-sink-connector -#### Experimental Connectors +### Experimental Connectors These connectors are not guaranteed to work with latest fluvio: * https://github.com/infinyon/labs-redis-sink-connector * https://github.com/infinyon/duckdb-connector -#### Community Connectors +### Community Connectors -Add your connector repository here: -* ... \ No newline at end of file +Connectors built and maintained by the community: + +* + +-> Please submit a pull request to add your connectors to this list! diff --git a/content/connectors/cdk/publish.md b/content/connectors/cdk/publish.md index 5bd0b376..32a6ec67 100644 --- a/content/connectors/cdk/publish.md +++ b/content/connectors/cdk/publish.md @@ -1,39 +1,80 @@ --- -title: Publish +title: Publish to Connector Hub +menu: Publish to Hub weight: 80 --- This section assumes `my-connector` project has been [generated]({{< ref "generate" >}}). -Connector Hub is a public repository of connectors. You can publish your connector as `private` to use on different computers or `pubic` to share it with the community. +Connector Hub is a public repository for connectors. You can publish your connector as `private` to use on different computers or `pubic` to share it with the community. -### Publish to Connector Hub +### Publish Connector to Hub -The final step would be to use `cdk publish` and publish the Connector to the Hub. +Use `cdk publish` to publish your connector to the Hub. If run without arguments, it will pack everything needed into a package and push the package to the Hub. -If run without arguments, it will pack everything needed into a package and push the package to the Hub. +%copy first-line% +```bash +$ cdk publish +``` + +The connector is now available for download from the Hub. + + +### Show Hub Connectors + +Run `cdk hub list` to list connectors in the Hub. + +%copy first-line% +```bash +$ cdk hub list + CONNECTOR Visibility + infinyon-labs/graphite-sink@0.1.2 public + infinyon/duckdb-sink@0.1.0 public + infinyon/http-sink@0.2.6 public + infinyon/http-source@0.3.0 public + infinyon/kafka-sink@0.2.7 public + infinyon/kafka-source@0.2.5 public + infinyon/mqtt-source@0.2.5 public + infinyon/sql-sink@0.3.3 public + acme/my-connector0.1.0 private +``` + +You will see all `public` connectors and your own `private` connectors. -You inspect the package file and make modifications before the push: + +### Download from Hub & Run + +You can download and run any connector from the Hub. In this example, we'll create new directory to download and run `acme/my-connector0.1.0` connector: + + +%copy first-line% +```bash +$ mkdir test-conn; cd test-conn +``` + +Download the connector: %copy first-line% ```bash -% cdk publish --pack -Using hub https://hub-dev.infinyon.cloud -Creating package aj/my-connector@0.1.0 -.. fill out info in hub/package-meta.yaml -Package hub/my-connector-0.1.0.ipkg created +$ cdk hub download acme/my-connector0.1.0 ``` -Check the file and then push. The file is a Tar Gzip archive. +Use connector `.ipkg` package file and run it with the `--ipkg` option: %copy first-line% ```bash -$ cdk publish --push hub/my-connector-0.1.0.ipkg +$ cdk deploy start --ipkg acme/my-connector0.1.0.ipkg --config ../sample-config.yaml ``` -The `publish` command uses `hub/package-meta.yml` file with the metadata needed for the Hub. If it doesn’t exist, `cdk` creates it for you. Then, you can modify it, and the changes will be picked up on the subsequent command execution. +This command assumes that the sample config is the parent directory. + + +#### Run an Official Connector + +You can use the same step-by-step to download and run an official connecgtor. Check the connector documetation to ensure the configuration file is correct. + -## Steps +### Steps 1. [Generate a Connector]({{< ref "generate" >}}) 2. [Build and Test]({{< ref "build-test" >}}) diff --git a/content/connectors/cdk/secrets.md b/content/connectors/cdk/secrets.md index e106b574..e6b1259c 100644 --- a/content/connectors/cdk/secrets.md +++ b/content/connectors/cdk/secrets.md @@ -28,7 +28,7 @@ SECRET_NAME_2=SUPER_SECRET_VALUE In the [next section]({{< ref "publish" >}}) we'll publish our connector to the Hub. -## Steps +### Steps 1. [Generate a Connector]({{< ref "generate" >}}) 2. [Build and Test]({{< ref "build-test" >}}) diff --git a/content/connectors/cdk/start-shutdown.md b/content/connectors/cdk/start-shutdown.md index 3ea886f3..78e5ae4a 100644 --- a/content/connectors/cdk/start-shutdown.md +++ b/content/connectors/cdk/start-shutdown.md @@ -16,31 +16,6 @@ Log file: /private/tmp/my-connector/my-connector.log Connector runs with process id: 88589 ``` -#### Run an Official Connector - -You can use the same `cdk deploy` command to run an official connector from InfinyOn Hub: - -List available connectors: - -%copy first-line% -```bash -$ cdk hub list -``` - -Download a certified connector from the Hub (requires a free [InfinyOn Cloud](https://infinyon.cloud) account): - -%copy first-line% -```bash -$ cdk hub download infinyon/http-source@0.3.0 -``` - -Use `.ipkg` connector package file with the `--ipkg` option to run it: - -%copy first-line% -```bash -$ cdk deploy start --ipkg infinyon-http-source-0.3.0.ipkg --config sample-config.yaml -``` - ### List running connectors CDK offers a convenience function to list running connectors: