https://github.com/elkoyote07/kafkaflinkplayground
A friendly playground for experimenting with Kafka and Flink integration and development.
https://github.com/elkoyote07/kafkaflinkplayground
apache-flink apache-kafka big-data docker docker-compose flink java kafka opensource python streams web-ui
Last synced: 2 months ago
JSON representation
A friendly playground for experimenting with Kafka and Flink integration and development.
- Host: GitHub
- URL: https://github.com/elkoyote07/kafkaflinkplayground
- Owner: elkoyote07
- License: mit
- Created: 2023-12-28T19:19:51.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-28T20:16:56.000Z (over 2 years ago)
- Last Synced: 2025-02-25T16:49:40.044Z (over 1 year ago)
- Topics: apache-flink, apache-kafka, big-data, docker, docker-compose, flink, java, kafka, opensource, python, streams, web-ui
- Homepage:
- Size: 693 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Kafka Flink Playground
A friendly playground for experimenting with Kafka and Flink integration and development.
[](https://github.com/elkoyote07/KafkaFlinkPlayground?tab=MIT-1-ov-file)
## Overview
Kafka Flink Playground is a user-friendly environment designed for experimenting with Kafka and Flink integration and development. Explore Apache Kafka topics using the Kafka UI, monitor and manage Flink jobs and clusters with the Flink Dashboard, and seamlessly configure the setup through Docker Compose.
## Table of Contents
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
## Getting Started
To get started with this project, follow these steps:
### Prerequisites
- [Docker](https://www.docker.com/) installed on your machine.
### Installation
1. Clone the repository:
```bash
git clone https://github.com/elkoyote07/KafkaFlinkPlayground.git
cd KafkaFlinkPlayground
```
2. Set the necessary permissions for config.yml:
```bash
chmod 777 config.yml
```
The above command grants full permissions to config.yml, allowing Kafka UI to save configuration data to the volume.
## Usage
1. Start the services using Docker Compose:
```bash
docker-compose up -d
```
After successfully setting up the project, you can access the following web interfaces:
- **Kafka UI**: Visit [http://localhost:8080](http://localhost:8080) to explore and manage your Apache Kafka topics using the Kafka UI.
- **Flink Dashboard**: Access the Flink Dashboard at [http://localhost:8081](http://localhost:8081) to monitor and manage your Flink jobs and clusters.
Additionally, the Kafka server is running on port 9093. You can configure your Kafka clients to connect to this server for producing and consuming messages.
## Contributing
We welcome and appreciate contributions from everyone. Whether you're fixing a bug, improving documentation, or adding a new feature, your input is valuable.
## Reporting Issues
If you encounter any issues or have suggestions, please open an issue with a clear description of the problem or enhancement you're proposing.
## License
This project is licensed under the [MIT License](https://github.com/elkoyote07/KafkaFlinkPlayground?tab=MIT-1-ov-file).
### Third-Party Licenses
This project incorporates software with the Apache-2.0 license.
#### Apache-2.0 Licensed Software
- [wurstmeister/kafka](https://github.com/wurstmeister/kafka-docker?tab=Apache-2.0-1-ov-file#readme)
- [apache/flink](https://github.com/apache/flink/blob/master/LICENSE)
- [provectuslabs/kafka-ui](https://github.com/provectus/kafka-ui/blob/master/LICENSE)
Please ensure compliance with the licensing terms of the Apache-2.0 licensed software when using or contributing to this project.