Skip to content

Commit

Permalink
Fix docs (#10)
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredpetersen authored Nov 14, 2020
1 parent 606c495 commit 9d84b44
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 7 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [1.0.2] - 2020-11-13
### Fixed
- Fixed POM description to include source capability
- Minor corrections to the demo documentation

## [1.0.1] - 2020-11-11
### Added
- Added quickstart properties for the source connector
Expand Down
8 changes: 4 additions & 4 deletions docs/demo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,17 @@ Let's run Kafka Connect Redis against Kafka and a Redis cluster to get a feel fo
### Minikube
First we need to set up Kubernetes. We're going to use minikube for this so [make sure you have it installed](https://minikube.sigs.k8s.io/docs/start/) along with [`kubectl` 1.14 or higher](https://kubernetes.io/docs/tasks/tools/install-kubectl/).

Set up the cluster with a docker registry and some extra juice:
Set up minkube with some extra juice:
```bash
minikube start --cpus 2 --memory 10g
```

### Docker
Now that we have a local Kubernetes setup, we'll need a Docker image that contains Kafka Connect Redis.
Now that we have Kubernetes set up locally, we'll need a Docker image that contains Kafka Connect Redis.

Navigate to `demo/docker/` in this repository and run the following commands **in a separate terminal** to download the plugin and build the image for minikube:
```bash
curl -O https://oss.sonatype.org/service/local/repositories/releases/content/io/github/jaredpetersen/kafka-connect-redis/1.0.1/kafka-connect-redis-1.0.1.jar
curl -O https://oss.sonatype.org/service/local/repositories/releases/content/io/github/jaredpetersen/kafka-connect-redis/1.0.2/kafka-connect-redis-1.0.1.jar
eval $(minikube docker-env)
docker build -t jaredpetersen/kafka-connect-redis:latest .
```
Expand Down Expand Up @@ -50,7 +50,7 @@ kubectl -n kcr-demo run -it --rm redis-client --image redis:6 -- redis-cli --pas
## Teardown
Remove all of the created resources in Kubernetes:
```bash
k delete -k kubernetes
kubectl delete -k kubernetes
```

Delete the minikube cluster:
Expand Down
1 change: 0 additions & 1 deletion docs/demo/SINK.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ kafka-console-producer \
>{"payload":{"key":"{user.1}.interests","values":["reading"]},"schema":{"name":"io.github.jaredpetersen.kafkaconnectredis.RedisSaddCommand","type":"struct","fields":[{"field":"key","type":"string","optional":false},{"field":"values","type":"array","items":{"type":"string"},"optional":false}]}}
>{"payload":{"key":"{user.2}.interests","values":["sailing","woodworking","programming"]},"schema":{"name":"io.github.jaredpetersen.kafkaconnectredis.RedisSaddCommand","type":"struct","fields":[{"field":"key","type":"string","optional":false},{"field":"values","type":"array","items":{"type":"string"},"optional":false}]}}
>{"payload":{"key":"Sicily","values":[{"longitude":13.361389,"latitude":13.361389,"member":"Palermo"},{"longitude":15.087269,"latitude":37.502669,"member":"Catania"}]},"schema":{"name":"io.github.jaredpetersen.kafkaconnectredis.RedisGeoaddCommand","type":"struct","fields":[{"field":"key","type":"string","optional":false},{"field":"values","type":"array","items":{"type":"struct","fields":[{"field":"longitude","type":"double","optional":false},{"field":"latitude","type":"double","optional":false},{"field":"member","type":"string","optional":false}]},"optional":false}]}}
>{"payload":{},"schema":{}}
```

## Validate
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@

<groupId>io.github.jaredpetersen</groupId>
<artifactId>kafka-connect-redis</artifactId>
<version>1.0.1</version>
<version>1.0.2</version>
<packaging>jar</packaging>

<name>kafka-connect-redis</name>
<description>Kafka Connect Sink Connector for Redis</description>
<description>Kafka Connect source and sink connector for Redis</description>
<url>https://github.com/jaredpetersen/kafka-connect-redis</url>

<licenses>
Expand Down

0 comments on commit 9d84b44

Please sign in to comment.