Skip to content

Commit

Permalink
Merge pull request #92 from nityatadepalli123/master
Browse files Browse the repository at this point in the history
documentation changes
  • Loading branch information
JunliWang authored Jan 24, 2024
2 parents 2cd16b5 + e58c84d commit 782e81d
Show file tree
Hide file tree
Showing 6 changed files with 19 additions and 13 deletions.
4 changes: 2 additions & 2 deletions kafka-connect/IKS/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

## Deploying `eventstreams-kafkaconnect` to Kubernetes connecting to IBM Event Streams
## Deploying `eventstreams-kafka-connect` to Kubernetes connecting to IBM Event Streams

### Prerequisites

Expand All @@ -21,7 +21,7 @@ kubectl create configmap connect-log4j-config --from-file=connect-log4j.properti

### Run Kafka Connect in distributed mode in your Kubernetes cluster

Deploy the `ibmcom/eventstreams-kafkaconnect` Docker image:
Deploy the `event-streams-samples/eventstreams-kafka-connect` Docker image:

```shell
kubectl apply -f ./kafka-connect.yaml
Expand Down
2 changes: 1 addition & 1 deletion kafka-connect/IKS/kafka-connect.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ spec:
runAsUser: 5000
containers:
- name: kafkaconnect-container
image: event-streams-samples/eventstreams-kafkaconnect:latest
image: event-streams-samples/eventstreams-kafka-connect:latest
readinessProbe:
httpGet:
path: /
Expand Down
9 changes: 6 additions & 3 deletions kafka-connect/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# kafka-connect

This repository contains the artifacts required to build the `ibmcom/eventstreams-kafkaconnect` Docker image.
This repository contains the artifacts required to build the `event-streams-samples/eventstreams-kafka-connect` Docker image.

This image contains the Kafka Connect runtime and the [IBM Cloud Object Storage sink connector](https://github.com/ibm-messaging/kafka-connect-ibmcos-sink) and the [IBM MQ source connector](https://github.com/ibm-messaging/kafka-connect-mq-source).

A prebuilt image is provided on DockerHub: https://hub.docker.com/r/ibmcom/eventstreams-kafkaconnect.
A prebuilt image is provided on Github Packages, you can use the following command to pull the image:

```docker pull ghcr.io/ibm-messaging/event-streams-samples/eventstreams-kafka-connect:latest
```

## Running the image in Kubernetes

Instructions for running the `eventstreams-kafkaconnect` image in Kubernetes can be found [here](IKS/README.md).
Instructions for running the `event-streams-samples/eventstreams-kafka-connect` image in Kubernetes can be found [here](IKS/README.md).

## Building the image

Expand Down
6 changes: 3 additions & 3 deletions kafka-mirrormaker/IKS/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

## Deploying `eventstreams-kafkamirrormaker` to Kubernetes to replicate data between 2 Event Streams clusters
## Deploying `event-streams-samples/kafka-mirrormaker` to Kubernetes to replicate data between 2 Event Streams clusters

These steps detail how to replicate data from a Kafka cluster (source) to another Kafka cluster (destination) using the `eventstreams-kafkamirrormaker` image.
These steps detail how to replicate data from a Kafka cluster (source) to another Kafka cluster (destination) using the `event-streams-samples/kafka-mirrormaker` image.

### Prerequisites

Expand All @@ -27,7 +27,7 @@ kubectl create configmap tools-log4j-config --from-file=tools-log4j.properties

### Run Mirror Maker in your Kubernetes cluster

Deploy the `ibmcom/eventstreams-kafkamirrormaker` Docker image:
Deploy the `event-streams-samples/kafka-mirrormaker` Docker image:

```shell
kubectl apply -f ./kafka-mirrormaker.yaml
Expand Down
2 changes: 1 addition & 1 deletion kafka-mirrormaker/IKS/kafka-mirrormaker.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ spec:
runAsUser: 5000
containers:
- name: kafkamirrormaker-container
image: event-streams-samples/kafkamirrormaker:latest
image: event-streams-samples/kafka-mirrormaker:latest
env:
- name: TOPIC_REGEX
value: "mytopic"
Expand Down
9 changes: 6 additions & 3 deletions kafka-mirrormaker/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# kafka-mirrormaker

This repository contains the artifacts required to build the `ibmcom/eventstreams-kafkamirrormaker` Docker image.
This repository contains the artifacts required to build the `event-streams-samples/kafka-mirrormaker` Docker image.

This image contains [Kafka Mirror Maker](http://kafka.apache.org/documentation/#basic_ops_mirror_maker) and can be used to replicate data between clusters.

A prebuilt image is provided on DockerHub: https://hub.docker.com/r/ibmcom/eventstreams-kafkamirrormaker.
A prebuilt image is provided on Github Packages, you can use the following command to pull the image:

```docker pull ghcr.io/ibm-messaging/event-streams-samples/kafka-mirrormaker:latest
```

## Running the image in Kubernetes

Instructions for running the `eventstreams-kafkamirrormaker` image in Kubernetes can be found [here](IKS/README.md).
Instructions for running the `event-streams-samples/kafka-mirrormaker` image in Kubernetes can be found [here](IKS/README.md).

## Building the image

Expand Down

0 comments on commit 782e81d

Please sign in to comment.