Skip to content

Commit

Permalink
rename config-example.yml to config-sample.yml, (#744)
Browse files Browse the repository at this point in the history
that's the name of the file generated by `cdk generate`
  • Loading branch information
mrasputin authored Dec 21, 2023
1 parent e4b2cbb commit 0e28553
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
4 changes: 2 additions & 2 deletions content/connectors/cdk/build-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ If the connector builds successfully, it’s time to start an instance with `cdk

The `--config <PATH>` argument is required. It is a path to the configuration file in YAML format.

Generating the project with `cdk generate` should have created a sample config for you named `config-example.yaml`
Generating the project with `cdk generate` should have created a sample config for you named `sample-config.yaml`

%copy first-line%
```bash
$ cdk test --config config-example.yaml
$ cdk test --config sample-config.yaml
Finished release [optimized] target(s) in 0.16s
Connector runs with process id: 80380
Starting my-connector source connector with CustomConfig { foo: "bar" }
Expand Down
6 changes: 3 additions & 3 deletions content/connectors/cdk/start-shutdown.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ When you are ready, you can run `cdk deploy start` to run your connector in the

%copy first-line%
```bash
$ cdk deploy start --config config-example.yaml
$ cdk deploy start --config sample-config.yaml
Log file: /private/tmp/my-connector/my-connector.log
Connector runs with process id: 88589
```
Expand All @@ -28,7 +28,7 @@ Example:

%copy first-line%
```bash
$ cdk deploy start --ipkg infinyon-http-source-0.1.1.ipkg --config config-example.yaml
$ cdk deploy start --ipkg infinyon-http-source-0.1.1.ipkg --config sample-config.yaml
```
{{</idea>}}

Expand All @@ -40,7 +40,7 @@ In order to use [secrets]({{<ref "/connectors/secrets">}}), you can use the `--s

%copy first-line%
```bash
$ cdk deploy start --config config-example.yaml --secrets secrets.txt
$ cdk deploy start --config sample-config.yaml --secrets secrets.txt
```

In the secrets file, you should define a secret per line in the format `SECRET_NAME=SECRET_VALUE`.
Expand Down
2 changes: 1 addition & 1 deletion embeds/cdk/tree-output.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ $ tree
.
├── Cargo.toml
├── Connector.toml
├── config-example.yaml
├── sample-config.yaml
└── src
├── config.rs
└── main.rs
Expand Down
2 changes: 1 addition & 1 deletion embeds/cli/example/cdk-generate-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ $ cdk generate
Ignoring: /var/folders/r8/4x6_d2rn283946frzd1gc1pr0000gn/T/.tmptToFV3/cargo-generate.toml
[1/6] Done: Cargo.toml
[2/6] Done: Connector.toml
[3/6] Done: config-example.yaml
[3/6] Done: sample-config.yaml
[4/6] Done: src/config.rs
[5/6] Done: src/main.rs
[6/6] Done: src
Expand Down
6 changes: 3 additions & 3 deletions embeds/connectors/inbound/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Tutorial for [HTTP to SQL Pipeline](https://www.fluvio.io/docs/tutorials/data-pi
This is an example of simple connector config file:

```yaml
# config-example.yaml
# sample-config.yaml
apiVersion: 0.1.0
meta:
version: 0.2.5
Expand Down Expand Up @@ -63,7 +63,7 @@ The produced record in Fluvio topic will be:
Fluvio HTTP Source Connector supports Secrets in the `endpoint` and in the `headers` parameters:

```yaml
# config-example.yaml
# sample-config.yaml
apiVersion: 0.1.0
meta:
version: 0.2.5
Expand All @@ -89,7 +89,7 @@ Fluvio HTTP Source Connector supports [Transformations](https://www.fluvio.io/do
The previous example can be extended to add extra transformations to outgoing records:
```yaml
# config-example.yaml
# sample-config.yaml
apiVersion: 0.1.0
meta:
version: 0.2.5
Expand Down
2 changes: 1 addition & 1 deletion embeds/connectors/inbound/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ To try out Kafka Source connector locally, you can use Fluvio CDK tool:
```bash
fluvio install cdk

cdk deploy -p kafka-source start --config crates/kafka-source/config-example.yaml
cdk deploy -p kafka-source start --config crates/kafka-source/sample-config.yaml
```

## Transformations
Expand Down
6 changes: 3 additions & 3 deletions embeds/connectors/inbound/mqtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ JSON Serialized string with fields `mqtt_topic` and `payload`
This is an example of connector config file:

```yaml
# config-example.yaml
# sample-config.yaml
apiVersion: 0.1.0
meta:
version: 0.2.5
Expand All @@ -68,7 +68,7 @@ Run connector locally using `cdk` tool (from root directory or any sub-directory
```bash
fluvio install cdk
cdk deploy start --config config-example.yaml
cdk deploy start --config sample-config.yaml
cdk deploy list # to see the status
cdk deploy log my-mqtt-connector # to see connector's logs
Expand Down Expand Up @@ -102,7 +102,7 @@ Fluvio MQTT Source Connector supports [Transformations](https://www.fluvio.io/do

The previous example can be extended to add extra transformations to outgoing records:
```yaml
# config-example.yaml
# sample-config.yaml
apiVersion: 0.1.0
meta:
version: 0.2.5
Expand Down
4 changes: 2 additions & 2 deletions embeds/connectors/outbound/http.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ HTTP sink connector reads records from data streaming and generates an HTTP requ
HTTP Sink is configured using a YAML file:

```yaml
# config-example.yaml
# sample-config.yaml
apiVersion: 0.1.0
meta:
version: 0.2.5
Expand Down Expand Up @@ -130,7 +130,7 @@ Fluvio HTTP Sink Connector supports [Transformations](https://www.fluvio.io/docs

The previous example can be extended to add extra transformations to outgoing records:
```yaml
# config-example.yaml
# sample-config.yaml
apiVersion: 0.1.0
meta:
version: 0.2.5
Expand Down
2 changes: 1 addition & 1 deletion embeds/connectors/outbound/kafka.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ To try out Kafka Sink connector locally, you can use Fluvio CDK tool:
```bash
fluvio install cdk

cdk deploy -p kafka-sink start --config crates/kafka-sink/config-example.yaml
cdk deploy -p kafka-sink start --config crates/kafka-sink/sample-config.yaml
```

### Testing with security
Expand Down

0 comments on commit 0e28553

Please sign in to comment.