A docker-compose setup for running and managing KafKa (check Installation)
Detailed steps to set up the project on your Alpine LXC Container.
- Create
.ashrc
under/root
with the following content
# Set PATH
export PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
# Aliases
alias ll='ls -alF'
alias la='ls -A'
alias grep='grep --color=auto'
# Cargo
. "$HOME/.cargo/env"
- Create
.profile
under/root
with the following content
export ENV=$HOME/.ashrc
-
Run
ease of use
scripts to setup pre-requisites
- Clone the repository
# Clone the repository
git clone https://github.com/clonne101/kafka.git kafka-docker
# Navigate to the project directory
cd kafka-docker
# Copy `.env.example` to `.env` under `/root/kafka-docker/docker` by running the
# command below and update the `variables`
cp /root/kafka-docker/docker/.env.example /root/kafka-docker/docker/.env
Before running any of the commands below, kindly make sure you have completed the above installations for you Alpine Box.
#### Create required data directories - REQUIRED on FIRST-RUN
make create-dirs
#### Start kafka container
make start
#### Stop kafka container
make stop
#### Tail kafka container logs
make logs
#### Show kafka containers
make show
#### Clean kafka containers and volumes
make clean
#### Prints out command list when in doubt
make help
Guidelines for contributing to the project.
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature-name
). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature/your-feature-name
). - Open a pull request.
If you encounter any issues, have questions, or would like to suggest an enhancement, please submit an issue through the GitHub repository.
- Search for existing issues: Before creating a new issue, please check if the issue has already been reported.
- Open a new issue: If no existing issue matches your problem, open a new issue by clicking on the "New Issue" button in the Issues tab.
- Describe the issue: Provide a clear and concise description of the issue. Include steps to reproduce the problem, expected behavior, and actual behavior. If applicable, add screenshots or code snippets to illustrate the issue.
- Label the issue: Add relevant labels (e.g., bug, enhancement, question) to help categorize the issue.
This project is licensed under the GPLv3 License.
Please read the Code of Conduct for details.
- Email: [email protected]
- GitHub: clonne101